Skip to main content
POST
Pause a subscription

Authorizations

X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

subscription_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$

Body

Input serializer for pausing a subscription.

paused_at
string<date-time>
required

When the pause starts (ISO 8601 datetime).

scheduled_resume_at
string<date-time> | null

Optional scheduled resume date (ISO 8601 datetime). If provided, the subscription end date will be extended by the pause duration. If not provided, the pause is open-ended and extension happens at resume time. Note: If no scheduled_resume_at is provided and the subscription remains paused past its end date, the subscription will be terminated.

pause_reason
string
default:""

Optional reason for pausing the subscription.

notify_customer
boolean
default:false

Whether to send the customer a notification about the pause.

Response

Output serializer for pause subscription response.

subscription_id
string<uuid>
required

ID of the subscription.

pause_id
string<uuid>
required

ID of the pause record.

paused_at
string<date-time>
required

When the pause started.

scheduled_resume_at
string<date-time> | null
required

When the subscription is scheduled to automatically resume (set at pause time).

resumed_at
string<date-time> | null
required

When the subscription was actually resumed (null if still paused).

extension_days
integer
required

Number of days the subscription end date was extended.

is_active
boolean
required

Whether the pause is currently active.