Skip to main content
GET
/
checkout_links
List checkout links
curl --request GET \
  --url https://api.crevio.co/v1/checkout_links \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "url": "<string>",
      "successUrl": "<string>",
      "allowDiscountCodes": true,
      "prefixId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "discount": {
        "id": 123,
        "status": "active",
        "discountType": "amount_off",
        "code": "<string>",
        "redeemBy": "2023-11-07T05:31:56Z",
        "maxRedemptions": 123,
        "timesRedeemed": 123,
        "duration": "once",
        "durationInMonths": 123,
        "amountOff": 123,
        "percentOff": 123,
        "currency": "<string>",
        "prefixId": "<string>",
        "destroyable": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "priceVariants": [
          {
            "id": 123,
            "name": "<string>",
            "amount": 123,
            "currency": "<string>",
            "billingType": "one_time",
            "amountType": "<string>",
            "discountedFromAmount": 123,
            "presetAmount": 123,
            "minimumAmount": 123,
            "maximumAmount": 123,
            "recurringInterval": "<string>",
            "intervalCount": 123,
            "trialPeriodDays": 123,
            "revokeAfterDays": 123,
            "hidden": true,
            "archived": true,
            "waitlist": true,
            "position": 123,
            "prefixId": "<string>",
            "benefits": [
              "<string>"
            ],
            "seatQuantity": 123,
            "isDefault": true,
            "isPayWhatYouWant": true,
            "hasFreeTrial": true,
            "isQuantityLimited": true
          }
        ]
      },
      "priceVariants": [
        {
          "id": 123,
          "name": "<string>",
          "amount": 123,
          "currency": "<string>",
          "billingType": "one_time",
          "amountType": "<string>",
          "discountedFromAmount": 123,
          "presetAmount": 123,
          "minimumAmount": 123,
          "maximumAmount": 123,
          "recurringInterval": "<string>",
          "intervalCount": 123,
          "trialPeriodDays": 123,
          "revokeAfterDays": 123,
          "hidden": true,
          "archived": true,
          "waitlist": true,
          "position": 123,
          "prefixId": "<string>",
          "benefits": [
            "<string>"
          ],
          "seatQuantity": 123,
          "isDefault": true,
          "isPayWhatYouWant": true,
          "hasFreeTrial": true,
          "isQuantityLimited": true
        }
      ],
      "products": [
        {
          "id": 123,
          "name": "<string>",
          "slug": "<string>",
          "prefixId": "<string>",
          "url": "<string>"
        }
      ],
      "qrCode": {
        "filename": "<string>",
        "contentType": "<string>",
        "byteSize": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "signedId": "<string>",
        "src": "<string>",
        "srcSet": "<string>"
      }
    }
  ],
  "pagination": {
    "count": 123,
    "from": 123,
    "in": 123,
    "last": 123,
    "limit": 123,
    "next": 123,
    "previous": 123,
    "offset": 123,
    "page": 123,
    "pages": 123,
    "to": 123
  }
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Paginated list of checkout links

items
object[]
pagination
object