Skip to main content
POST
Change the plan of an existing subscription

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.

Body

application/json
plan
enum<string>
required
Available options:
starter,
pro,
business
billing_period
enum<string>
default:monthly
Available options:
monthly,
yearly
confirm_leave_legacy
boolean

Response

Plan change requested; the new plan arrives with the subscription webhook

ok
boolean

False when the change has to be finished in the customer portal

plan
string
invoiced_now
boolean
portal_url
string

Present when the customer must finish the change in the Lemon Squeezy portal (PayPal)