Skip to main content
POST
Pause a subscription

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

token
string
required

Query Parameters

next_bill_date
string<date>

Resume date for paused subscription. Omit for indefinite pause.

number_of_orders
integer

Number of billing cycles to skip. Cannot be used with next_bill_date.

Response

string | number | boolean | null | any[] | object

Success

Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.