Skip to main content
POST
Preview a subscription change

Authorizations

Authorization
string
header
required

JWT authentication token

Body

application/json
credits_per_user
integer
demote_member_emails
string[]

Required when reducing seats below the current premium-member count: the member emails to demote to non-premium (no credits) at the next renewal. Must be enough to bring the premium count down to the new seat count.

interval
enum<string>
Available options:
month,
year
seats
integer

Response

Change preview

amount_due_cents
integer
amount_due_display
string
change_type
enum<string>
Available options:
upgrade,
downgrade,
cycle_switch,
none
effective_at
string<date-time>
immediate
boolean
line_items
object[]
prorated_credits
number<double>