Confirm subscription checkout session

POST

/api/v1/subscriptions/checkout-sessions/{checkoutSessionUid}/confirm

Subscriptions

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Checkout session confirmed

Body

🟠400Bad Request

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/checkout-sessions//confirm' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "walletAddress": "string",
    "tokenId": "string",
    "limits": {
        "capAmount": "string",
        "maxPerCharge": "string"
    },
    "schedule": {
        "periodSeconds": 0,
        "nextDue": 0,
        "expiry": 0
    }
}'

Response Example

200 - sample

{
    "token": {
        "address": "0x55d398326f99059fF775485246999027B3197955",
        "symbol": "USDT",
        "decimals": 18,
        "chainId": 56
    },
    "auth": {
        "merchantId": "merchant_123",
        "authId": "auth_456",
        "spender": "0x1234567890123456789012345678901234567890",
        "collector": "0x0987654321098765432109876543210987654321"
    },
    "allowance": {
        "method": "approve",
        "spender": "0x1234567890123456789012345678901234567890",
        "requiredAllowanceUnits": "1000000000000000000000"
    },
    "eip712": {
        "domain": {
            "name": "SubscriptionSpender",
            "version": "1",
            "chainId": 56,
            "verifyingContract": "0x1234567890123456789012345678901234567890"
        },
        "types": {
            "EIP712Domain": [
                {
                    "name": "name",
                    "type": "string"
                },
                {
                    "name": "version",
                    "type": "string"
                },
                {
                    "name": "chainId",
                    "type": "uint256"
                },
                {
                    "name": "verifyingContract",
                    "type": "address"
                }
            ],
            "SubscriptionAuth": [
                {
                    "name": "merchantId",
                    "type": "string"
                },
                {
                    "name": "authId",
                    "type": "string"
                },
                {
                    "name": "subscriber",
                    "type": "address"
                },
                {
                    "name": "token",
                    "type": "address"
                },
                {
                    "name": "amount",
                    "type": "uint256"
                },
                {
                    "name": "period",
                    "type": "uint256"
                },
                {
                    "name": "deadline",
                    "type": "uint256"
                }
            ]
        },
        "message": {
            "merchantId": "merchant_123",
            "authId": "auth_456",
            "subscriber": "0xabcdef1234567890abcdef1234567890abcdef12",
            "token": "0x55d398326f99059fF775485246999027B3197955",
            "amount": "1000000000000000000000",
            "period": 2592000,
            "deadline": 1704110400
        }
    },
    "preview": {
        "type": "TRIAL",
        "fromAmountHuman": "10.00",
        "fromAmountUnits": "10000000000000000000",
        "expiresAt": 1704110400
    }
}

Modified at 2025-09-15 21:23:04

Get a subscription checkout session by UID

Get stablecoin currencies supported for subscriptions