List All Checkouts

GET

/v1/checkouts

Returns a paginated list of checkouts.


Filter parameters

store_id

Only return checkouts belonging to the store with this ID.

variant_id

Only return checkouts belonging to the variant with this ID.


curl "https://api.lemonsqueezy.com/v1/license-keys" \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}'
curl "https://api.lemonsqueezy.com/v1/license-keys?filter[order_id]=1" \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}'

Returns

Returns a paginated list of Checkout objects ordered by created_at in descending order.

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 10,
      "to": 10,
      "total": 10
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://api.lemonsqueezy.com/v1/checkouts?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt",
    "last": "https://api.lemonsqueezy.com/v1/checkouts?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=-createdAt"
  },
  "data": [
    {
      "type": "checkouts",
      "id": "ac470bd4-7c41-474d-b6cd-0f296f5be02a",
      "attributes": {
        "store_id": 1,
        "variant_id": 1,
        "custom_price": null,
        "product_options": {
          "name": "",
          "description": "",
          "media": [],
          "redirect_url": "",
          "receipt_button_text": "",
          "receipt_link_url": "",
          "receipt_thank_you_note": "",
          "enabled_variants": []
        },
        "checkout_options": {
          "embed": false,
          "media": true,
          "logo": true,
          "desc": true,
          "discount": true,
          "skip_trial": true,
          "dark": false,
          "subscription_preview": true,
          "button_color": "#7047EB"
        },
        "checkout_data": {
          "email": "",
          "name": "",
          "billing_address": [],
          "tax_number": "",
          "discount_code": "",
          "custom": [],
          "variant_quantities": []
        },
        "expires_at": null,
        "created_at": "2022-10-14T12:36:27.000000Z",
        "updated_at": "2022-10-14T12:36:27.000000Z",
        "test_mode": false,
        "url": "https://my-store.lemonsqueezy.com/checkout/custom/ac470bd4-7c41-474d-b6cd-0f296f5be02a?signature=ee3fd20c5bac48fe5e976cb106e743bc3f6f330540f8003ab331d638e2ce3b8b"
      },
      "relationships": {
        "store": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a/store",
            "self": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a/relationships/store"
          }
        },
        "variant": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a/variant",
            "self": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a/relationships/variant"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a"
      }
    },
    {...},
    {...},
  ]
}

Was this page helpful?