Skip to main content
POST
/
subscriptions
/
{subscription_id}
/
resume
Resume a paused subscription
curl --request POST \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "should_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",
  "pause_duration_days": 123,
  "ends_at": "2023-12-25"
}

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 resuming a paused subscription.

​
should_notify_customer
boolean
default:false

Whether to notify the customer about the subscription resumption.

Response

Output serializer for resume 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).

​
pause_duration_days
integer
required

Actual number of days the subscription was paused.

​
ends_at
string<date>
required

The subscription end date (adjusted based on pause duration).