Checkout
Checkout Endpoints allow you to create checkout sessions for your shop. Business Plan Subscription is required to create checkout sessions.
Create Checkout Session
Creates a new checkout session for the shop. This endpoint requires an API key and must be called from your backend.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredcartRequiredarray<object>ipstringMust be a valid IP address.
country_codestringMust contain only letters. Must be 2 characters.
user_agentstringasnintegeremailstringMust be a valid email address.
discord_user_idstringdiscord_user_usernamestringdiscord_access_tokenstringdiscord_refresh_tokenstringcouponstringgatewaystringDEPRECATED. The payment gateway to preselect. CUSTOMERBALANCE, STRIPE, SQUARE, SUMUP, MOLLIE, SKRILL, AUTHORIZENET, REVOLUTBUSINESS, LEMONSQUEEZY, NMI, OVERPAY, SWIFTPAY, ADYEN, SHOPIFY, AMAZONPS, PAYPAL, PAYPALFF, CASHAPP, VENMO, BTC, LTC.
payment_method_idstringThe ID of the payment method to preselect. Can be found in the URL when editing a Payment Method in the Dashboard.
newsletterbooleanaffiliatestringMust not be greater than 16 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.