Upgrade subscription

PreviousRemove TOTP MFA key NextCancel subscription

Last updated 9 months ago

Was this helpful?

Upgrade subscription

Upgrade the current subscription.

post

/api/user/subscription/upgrade

Authorizations

Body

billingCyclestring · enumrequired

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

Options: monthly, yearly

successUrlstringrequired

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

cancelUrlstringrequired

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

Responses

cURL

JavaScript

Python

HTTP

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

302

No body

A redirect to the payment portal