Abandoned Checkouts6

Activity Logs1

Affiliate Payouts3

Affiliate Tiers6

Affiliates11

Analytics10

Anti-Fraud1

Blacklist8

Blog Posts8

Bundle Offers5

Categories6

Checkout1

post/v1/shops/{shopId}/checkoutCreate Checkout Session

Coupons7

Crypto Wallet6

Custom Fields4

Customers12

Disputes15

Domains4

Downloadable Files4

Email Marketing - Automations6

Email Marketing - Campaigns13

Email Marketing - Contacts2

Email Marketing - Lists10

Email Marketing - Stats2

Email Marketing - Templates8

Endpoints2

Feedbacks8

Groups5

Images5

Invoices22

Legal Pages3

Notifications8

Payment Methods8

Products39

Quantity Deals5

Reseller Connect2

Reseller Products2

Reseller Tiers6

Resellers15

Shipping Zones5

Shops6

Subscriptions6

Tickets10

User1

Webhook Logs1

Whitelist7

Checkout

Create Checkout Session

Changed on Nov 2, 2026

Creates a checkout session (invoice) server-side and returns the URL to send the buyer to. Requires an API key; call it from your backend, never from a browser. Cart items are either catalog items (<code>productId</code> + <code>variantId</code>) or custom items (<code>name</code> + <code>price</code>, for one-off charges that are not in your catalog); both kinds can be mixed. If you pass both <code>email</code> and a payment method, the invoice is created as <code>pending</code> and a payment session is started immediately, so the returned <code>url</code> goes straight to the payment provider; otherwise it opens the hosted checkout where the buyer completes those steps. Available on plans with the Checkout API feature.

post/v1/shops/{shopId}/checkout

Request

Base URL
https://api.sellauth.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sellauth/apis/sellauth-api/docs/v1/shops/:shopId/checkout/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

currencystring nullable

ISO 4217 currency code. Required when every cart item is a custom item; otherwise inferred from the products. Must be 3 characters.

ipstring nullable

The end buyer's IP address. Defaults to the caller's IP; forward the buyer's IP when calling from your backend so fraud checks and analytics see the real buyer. Must be a valid IP address.

country_codestring nullable

The end buyer's ISO 3166-1 alpha-2 country code. Must contain only letters. Must be 2 characters.

user_agentstring nullable

The end buyer's user agent. Defaults to the caller's user agent.

asninteger nullable

The end buyer's autonomous system number, if you have it.

emailstring nullable

Prefill the customer email. When both <code>email</code> and a payment method are provided, the invoice is created as <code>pending</code> and a payment session is started immediately.

discord_user_idstring nullable

Internal: link the customer's Discord account.

discord_user_usernamestring nullable

Internal: link the customer's Discord account.

discord_access_tokenstring nullable

Internal: link the customer's Discord account.

discord_refresh_tokenstring nullable

Internal: link the customer's Discord account.

couponstring nullable

A coupon code to apply.

gatewaystring nullable

DEPRECATED, use <code>payment_method_id</code>. The payment gateway type to preselect. One of <code>STRIPE</code>, <code>SQUARE</code>, <code>SUMUP</code>, <code>MOLLIE</code>, <code>SKRILL</code>, <code>AUTHORIZENET</code>, <code>REVOLUTBUSINESS</code>, <code>LEMONSQUEEZY</code>, <code>NMI</code>, <code>OVERPAY</code>, <code>MONEI</code>, <code>RAZORPAY</code>, <code>PANDABASE</code>, <code>VENPAYR</code>, <code>OVGC</code>, <code>DODOPAYMENTS</code>, <code>PAYMONGO</code>, <code>SHOPIFY</code>, <code>AMAZONPS</code>, <code>PAYCEK</code>, <code>PAYPAL</code>, <code>PAYPALFF</code>, <code>CASHAPP</code>, <code>VENMO</code>, <code>ZELLE</code>, <code>SKRILLP2P</code>, <code>REWARBLE</code>, <code>BTC</code>, <code>LTC</code>. <code>CUSTOMERBALANCE</code> is not allowed on this endpoint.

payment_method_idinteger nullable

The payment method to preselect. Shown in the URL when editing a payment method in the dashboard. When set together with <code>email</code>, a payment session is started immediately and the response <code>url</code> points to the payment page.

newsletterboolean nullable

Subscribe the customer to the shop newsletter. Only send true if the customer actually consented; false or omitted leaves their current subscription untouched, and a customer who unsubscribed themselves stays unsubscribed.

affiliatestring nullable

An affiliate code to credit for this sale. Must not be greater than 16 characters.

billing_namestring nullable

Prefill: billing name. Must not be greater than 100 characters.

billing_address_line1string nullable

Prefill: billing address line 1. Must not be greater than 150 characters.

billing_address_line2string nullable

Prefill: billing address line 2. Must not be greater than 150 characters.

billing_citystring nullable

Prefill: billing city. Must not be greater than 100 characters.

billing_statestring nullable

Prefill: billing state or region. Must not be greater than 100 characters.

billing_postcodestring nullable

Prefill: billing postcode. Must not be greater than 20 characters.

billing_countrystring nullable

Prefill: billing country (ISO 3166-1 alpha-2). Must be 2 characters.

shipping_namestring nullable

Prefill: shipping name. Must not be greater than 100 characters.

shipping_address_line1string nullable

Prefill: shipping address line 1. Must not be greater than 150 characters.

shipping_address_line2string nullable

Prefill: shipping address line 2. Must not be greater than 150 characters.

shipping_citystring nullable

Prefill: shipping city. Must not be greater than 100 characters.

shipping_statestring nullable

Prefill: shipping state or region. Must not be greater than 100 characters.

shipping_postcodestring nullable

Prefill: shipping postcode. Must not be greater than 20 characters.

shipping_countrystring nullable

Prefill: shipping country (ISO 3166-1 alpha-2). Must be 2 characters.

shipping_phonestring nullable

Prefill: shipping phone number. Must not be greater than 20 characters.

metadatastring[]

Must not be greater than 255 characters.

Example request

{
  "cart": [
    {
      "productId": 1,
      "variantId": 1,
      "quantity": 1
    }
  ],
  "currency": "USD",
  "ip": "203.0.113.10",
  "country_code": "US",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
  "asn": 64496,
  "email": "customer@example.com",
  "coupon": "SAVE10",
  "gateway": "STRIPE",
  "payment_method_id": 1,
  "affiliate": "PARTNER10",
  "billing_name": "John Doe",
  "billing_address_line1": "123 Main St",
  "billing_address_line2": "Apt 4",
  "billing_city": "Springfield",
  "billing_state": "IL",
  "billing_postcode": "62701",
  "billing_country": "US",
  "shipping_name": "John Doe",
  "shipping_address_line1": "123 Main St",
  "shipping_address_line2": "Apt 4",
  "shipping_city": "Springfield",
  "shipping_state": "IL",
  "shipping_postcode": "62701",
  "shipping_country": "US",
  "shipping_phone": "+1 555 0100",
  "metadata": [
    "tjqotbhpzwonwlzospqcs"
  ],
  "attribution": {
    "utm_source": "newsletter",
    "utm_medium": "email",
    "utm_campaign": "spring_sale"
  }
}

Response

Example response

{
  "success": true,
  "invoice_id": 3,
  "invoice_url": "https://demo-shop.sellauth.com/checkout/98b3f45d848c5-0000000000003",
  "url": "https://checkout.stripe.com/c/pay/cs_test_a139AH1zApQWCLRABDj7fBVDZ0puTeWxKQMeOENUVAv0NzDmBVbCwSKYTX"
}

Changes

Nov 2, 2026ff0d59c98d7a Revision changes
- breaking
  added subschema #1 subschema #2 to the response body oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body oneOf list for the response status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property / became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property /// became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property / became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
Oct 20, 2026000b5ef816e6 Revision changes
- breaking
  added the new required request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //

Operation history (4 revisions)

Create Checkout Session

Request

Request body

Example request

Response 200OK

Example response

Changes

Response