POST
/
api
/
user
/
subscription
/
upgrade
Upgrade subscription
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/user/subscription/upgrade \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "billingCycle": "monthly",
  "successUrl": "<string>",
  "cancelUrl": "<string>"
}'

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
billingCycle
enum<string>
required

Selects the billing frequency for the subscription. Either 'monthly' for regular monthly charges or 'yearly' for annual billing with a potential discount.

Available options:
monthly,
yearly
​
successUrl
string
required

URL to redirect the user to after a successful checkout process.

​
cancelUrl
string
required

URL to redirect the user to after the checkout process is canceled.

Response

302

A redirect to the payment portal