Pause a Subscription

Developing

POST

/subscriptions/{subscriptionID}/pause

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-staging.tenbyte.io/v1/subscriptions/subs_01K8J9N6Y58871HCEWWJZRZ6XS/pause' \
--header 'x-api-key: sk_01K83C267DXG1K9AJGGKH23VVH' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pause_mode": "immediate",
    "pause_end":"2025-11-27T07:52:30.965403511Z"
}'

Response Example

{
    "subscription_id": "subs_01K85ZX4DJ57AKVWZJPK2CZ5YF",
    "cancellation_type": "end_of_period",
    "effective_date": "2025-11-22T12:57:04Z",
    "status": "active",
    "proration_details": null,
    "total_credit_amount": "0",
    "message": "Subscription will be cancelled at the end of the current period (2025-11-22)",
    "processed_at": "2025-10-22T12:57:33.978590088Z"
}

Modified at 2025-10-27 07:55:55

Cancel a Subscription

Ingest event