Checkout

Create Checkout Session

Changed on

Creates a Stripe Checkout Session for browser-based checkout. Returns a URL to redirect the user to Stripe's hosted checkout page.

post/iap/checkout-sessions

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/checkout-sessions
  • Auth
    API key in header X-ZeroSettle-Key

Request body

product_idstring required

The product's reference_id (e.g., com.app.premium).

external_user_idstring

The user's external ID. Either this or user_id is required.

user_idstring

Alias for external_user_id. Either this or external_user_id is required.

platform'ios' | 'android' | 'web'

The platform the purchase is being made from.

stripe_customer_idstring

Existing Stripe customer ID to attach the payment to.

rc_app_user_idstring

RevenueCat app user ID, if using RevenueCat integration.

Response

Checkout session created successfully

checkout_session_idstring

Stripe Checkout Session ID.

urlstring

URL to redirect the user to for checkout.

client_secretstring

Client secret for embedded checkout.

transaction_idstring

ZeroSettle transaction ID.

Changes