Create Checkout Sessions

POST

/api/v1/subscriptions/checkout-sessions

Subscriptions

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Default Response

Body

🟠400Bad Request

🟠409

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/checkout-sessions' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "priceUid": "string",
    "billingMode": "FIXED",
    "expectedUsage": {
        "amount": 0,
        "currency": "string"
    },
    "strategy": "moderate",
    "customMultiplier": 1,
    "customer": {
        "email": "user@example.com",
        "firstName": "string",
        "lastName": "string"
    },
    "successUrl": "http://example.com",
    "cancelUrl": "http://example.com",
    "metadata": {}
}'

Response Example

201 - Example 1

{
    "checkoutSession": {
        "uid": "string",
        "approval_url": "string"
    },
    "subscription": {
        "uid": "string"
    },
    "customer": {
        "uid": "string"
    }
}

Modified at 2026-01-06 17:05:00

Update Prices Details

Get Checkout Sessions Details