Create Checkout Link
Create a checkout link.
Scopes: checkout_links:write
Looking to create a single use checkout session? Checkout Links are probably not what you’re looking for.
Checkout Links are shareable links that generate checkout sessions when opened. They are very handy to start a purchase from your website or social media.
However, if you want to start a checkout for one of your user inside your product, you should use the Checkout Sessions API.
Authorizations
You can generate an Organization Access Token from your organization's settings.
Body
Schema to create a new checkout link from a a single product price.
Deprecated: Use CheckoutLinkCreateProducts
instead.
Payment processor to use. Currently only Stripe is supported.
"stripe"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Optional label to distinguish links internally
Whether to allow the customer to apply discount codes. If you apply a discount through discount_id
, it'll still be applied, but the customer won't be able to change it.
Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID}
query parameter to retrieve the checkout session id.
1 - 2083
Schema to create a new checkout link from a a single product price.
Deprecated: Use CheckoutLinkCreateProducts
instead.
Payment processor to use. Currently only Stripe is supported.
"stripe"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Optional label to distinguish links internally
Whether to allow the customer to apply discount codes. If you apply a discount through discount_id
, it'll still be applied, but the customer won't be able to change it.
Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID}
query parameter to retrieve the checkout session id.
1 - 2083
Schema to create a new checkout link from a a single product.
Deprecated: Use CheckoutLinkCreateProducts
instead.
Payment processor to use. Currently only Stripe is supported.
"stripe"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Optional label to distinguish links internally
Whether to allow the customer to apply discount codes. If you apply a discount through discount_id
, it'll still be applied, but the customer won't be able to change it.
Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID}
query parameter to retrieve the checkout session id.
1 - 2083
Schema to create a new checkout link.
Payment processor to use. Currently only Stripe is supported.
"stripe"
List of products that will be available to select at checkout.
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Optional label to distinguish links internally
Whether to allow the customer to apply discount codes. If you apply a discount through discount_id
, it'll still be applied, but the customer won't be able to change it.
Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID}
query parameter to retrieve the checkout session id.
1 - 2083
Response
Checkout link data.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Payment processor used.
stripe
Client secret used to access the checkout link.
URL where the customer will be redirected after a successful payment.
Optional label to distinguish links internally
Whether to allow the customer to apply discount codes. If you apply a discount through discount_id
, it'll still be applied, but the customer won't be able to change it.
Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
The organization ID.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Product data for a checkout link.