Pause an active subscription

POST

/subscriptions/{id}/pause

• Production
• Test (use test keys with the same host; sandbox semantics apply)

Authorizations

• bearerAuth
• xApiKey

Parameters

Header Parameters

Idempotency-Key

string

<= 255 characters

Unique identifier used to replay requests safely.

Responses

200

Subscription paused (status paused).

400

Error response.

Media typeapplication/json

object

error

required

string

message

string

code

string

details

object

Example ^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "details": {}
}

403

Error response.

Media typeapplication/json

object

error

required

string

message

string

code

string

details

object

Example ^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "details": {}
}

404

Error response.

Media typeapplication/json

object

error

required

string

message

string

code

string

details

object

Example ^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "details": {}
}