Skip to main content
POST
/
api
/
v2
/
subscriptions
/
{subscription_id}
/
terminate
Terminate a subscription
curl --request POST \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/terminate \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "termination_date": "2023-12-25",
  "termination_notes": "<string>",
  "notification_emails": [
    "[email protected]"
  ]
}
'
{
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "termination_date": "2023-12-25",
  "termination_notes": "<string>",
  "notification_emails": [
    "[email protected]"
  ]
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

​
subscription_id
string
required

Body

Subscription terminate input serializer.

​
termination_date
string<date> | null

The date when the subscription should be terminated. If not provided, the subscription will be terminated immediately.

​
termination_notes
string | null

Optional notes or reason for terminating the subscription. This information may be used for record-keeping and analysis.

​
notification_emails
string<email>[]

List of email addresses that should receive notifications about the subscription termination. If not provided, no additional notifications will be sent beyond the standard termination process.

Response

Subscription terminate output serializer.

​
subscription_id
string<uuid>
required

ID of the subscription

​
termination_date
string<date> | null

The date when the subscription should be terminated. If not provided, the subscription will be terminated immediately.

​
termination_notes
string | null

Optional notes or reason for terminating the subscription. This information may be used for record-keeping and analysis.

​
notification_emails
string<email>[]

List of email addresses that should receive notifications about the subscription termination. If not provided, no additional notifications will be sent beyond the standard termination process.