Skip to main content
POST
Pause Subscription

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Path Parameters

provider_subscription_id
string
required

Provider subscription ID (e.g. test_subscription_id).

Body

application/json
cycles
integer | null

How many billing cycles to pause for. Positive integer, or null for an open-ended pause (clears any previously scheduled resume). Omit the field entirely, rather than sending an empty body, to leave an existing scheduled resume untouched.

Response

Success.

data
object
required