Skip to main content
POST
Pause a subscription

Path Parameters

Request Body

Example Request

Response

While paused, no invoices are generated and the customer is not charged. The subscription resumes automatically at resume_at if provided.

Errors

See Errors for the error envelope and the full code taxonomy.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Response

Paused subscription.

data
object