Create subscription checkout session

POST

/api/v1/subscriptions/checkout-sessions

Subscriptions

Create a new subscription checkout session for either FIXED or METERED billing.

📖 For detailed implementation guide, see: Subscriptions Documentation

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Checkout session created

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/checkout-sessions' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "priceUid": "string",
    "billingMode": "FIXED",
    "targetPrice": {
        "targetCurrency": "NGN",
        "targetAmount": "1000.00"
    },
    "customer": {
        "email": "user@example.com",
        "firstName": "string",
        "lastName": "string"
    },
    "successUrl": "http://example.com",
    "cancelUrl": "http://example.com"
}'

Response Example

201 - sample

{
    "checkoutSession": {
        "uid": "cs_1234567890abcdef",
        "approval_url": "https://checkout.kuvarpay.com/approve/cs_1234567890abcdef"
    },
    "subscription": {
        "uid": "sub_abcdef1234567890"
    },
    "customer": {
        "uid": "cus_fedcba0987654321"
    }
}

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

Create a new payment link

Get a subscription checkout session by UID