PATCH
/
subscriptions
/
{id}
Update subscription
curl --request PATCH \
  --url https://api.smokeball.com/subscriptions/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "tierId": "8d074e85-4d95-4d9a-8a63-187719470d49",
  "addOnIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "interval": "Monthly",
  "reason": "<string>"
}'
This response does not have an example.

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

The unique identifier of the subscription to update

Body

The subscription update request

​
tierId
string | null

Optional tier id to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the supplied tier id.

Example:

"8d074e85-4d95-4d9a-8a63-187719470d49"

​
addOnIds
string[] | null

Optional add-on ids to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the existing or supplied tier id.

​
interval
string | null

Optional billing interval/pricing option to use when setting subscription tier.

If an interval is not supplied then the default interval option will be used.

If an interval is supplied but a tier is not supplied, the existing tier is used and the interval is changed.

Example:

"Monthly"

​
reason
string | null

Optional reason for changing the subscription tier.

Response

200

Successfully updated the subscription