Update Subscriptions Details

PATCH

/api/v1/subscriptions/{id}

Subscriptions

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Default Response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/subscriptions/' \
--header 'idempotency-key;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "ACTIVE",
    "cancel_at_period_end": true,
    "trial_end": "2019-08-24T14:15:22.123Z",
    "metadata": {}
}'

Response Example

{
    "success": true,
    "data": {
        "id": "string",
        "business_id": "string",
        "customer_id": "string",
        "price_id": "string",
        "payment_method_id": "string",
        "merchant_id": "string",
        "auth_id": "string",
        "status": "string",
        "current_period_start": "string",
        "current_period_end": "string",
        "trial_start": "string",
        "trial_end": "string",
        "cancel_at_period_end": true,
        "canceled_at": "string",
        "ended_at": "string",
        "metadata": {},
        "created_at": "string",
        "updated_at": "string"
    }
}

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

Get Subscriptions Details

Delete Subscriptions Details