Pause a subscription
Use when temporarily stopping a subscription (e.g. customer hold or seasonal pause). Billing and access pause; resume when ready.
Path parameters
Subscription ID
Request body
Whether to perform a dry run @Description If true, validates the request and shows impact without actually pausing the subscription @Example false
Additional metadata as key-value pairs @Description Optional metadata for storing additional information about the pause @Example {"requested_by": "customer", "channel": "support_ticket"}
Duration of the pause in days @Description Number of days to pause the subscription. Cannot be used together with pause_end. Must be greater than 0 @Example 30
End date for the subscription pause @Description ISO 8601 timestamp when the pause should end. Cannot be used together with pause_days. Must be after pause_start @Example "2024-02-15T00:00:00Z"
Start date for the subscription pause @Description ISO 8601 timestamp when the pause should begin. Required when pause_mode is "scheduled" @Example "2024-01-15T00:00:00Z"
Reason for pausing the subscription @Description Optional reason for the pause. Maximum 255 characters @Example "Customer requested temporary suspension"
Response
OK
EnvironmentID is the environment identifier for the pause
ID is the unique identifier for the subscription pause
OriginalPeriodEnd is the end of the billing period when the pause was created
OriginalPeriodStart is the start of the billing period when the pause was created
PauseEnd is when the pause will end (null for indefinite)
PauseStart is when the pause actually started
Reason is the reason for pausing
ResumedAt is when the pause was actually ended (if manually resumed)
SubscriptionID is the identifier for the subscription