Skip to main content
Start a subscription upgrade
curl --request POST \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/upgrade/{order_id}/start \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

​
order_id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
​
subscription_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

​
charge_immediately
enum<string>

Whether to attempt an immediate charge.

Available options:
no,
yes

Response

Common subscription response serializer that includes the ID of the subscription from the result of a subscription related operation.

​
subscription_id
string<uuid>
required

ID of the subscription