Create a new subscription plan

POST

/api/v1/subscriptions/plans

Subscriptions

Create a subscription plan that defines the service offering. Plans are used with prices to create FIXED billing subscriptions.

Note: METERED billing subscriptions do not require pre-created plans. They work directly with target pricing.

📖 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

Plan created successfully

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/plans' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Premium Plan",
    "description": "Premium subscription with advanced features",
    "metadata": {
        "tier": "premium"
    }
}'

Response Example

201 - Example 1

{
    "success": true,
    "data": {
        "uid": "string",
        "business_id": "string",
        "name": "string",
        "description": "string",
        "metadata": {},
        "status": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "prices": [
            "string"
        ]
    }
}

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

Cancel a subscription

List subscription plans