Skip to main content
POST
/
subscriptions
/
{subscription_id}
/
pause
Pause a subscription
curl --request POST \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/pause \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "paused_at": "2023-11-07T05:31:56Z",
  "scheduled_resume_at": "2023-11-07T05:31:56Z",
  "pause_reason": "",
  "notify_customer": false
}
'
{
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pause_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paused_at": "2023-11-07T05:31:56Z",
  "scheduled_resume_at": "2023-11-07T05:31:56Z",
  "resumed_at": "2023-11-07T05:31:56Z",
  "extension_days": 123,
  "is_active": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt

Use this file to discover all available pages before exploring further.

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.