Retrieve a Checkout
GET
/v1/checkouts/:id
Retrieves the checkout with the given ID.
curl "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a" \
-H 'Accept: application/vnd.api+json' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer {api_key}'Returns
Returns a Checkout object.
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://api.lemonsqueezy.com/v1/checkouts/ac470bd4-7c41-474d-b6cd-0f296f5be02a"
},
"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": 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": "2024-10-14T12:36:27.000000Z",
"updated_at": "2024-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"
}
}
}