Update a subscription plan

PATCH

/api/v1/subscriptions/plans/{uid}

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

Plan updated successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/subscriptions/plans/' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Premium Plan",
    "status": "ACTIVE",
    "metadata": {
        "tier": "premium",
        "updated": true
    }
}'

Response Example

200 - 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

Get a subscription plan by UID

Create a price for a subscription plan