Skip to main content
PATCH
Pause a subscription

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Path Parameters

uuid
string<uuid>
required

Body

application/json
paused_until
string<date> | null

Date after which the subscription auto-resumes. Must be in the future.

Example:

"2026-09-01"

Response

Subscription paused

data
object