Skip to main content
POST
Start a subscription upgrade

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 charge the first invoice to the customer's saved payment method during this request. Defaults to yes. With no, the order starts without a charge and the invoice is paid like any other: automatically on its charge date if the customer has auto-pay on (starting a card order turns it on), otherwise by the customer.

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