Change the plan
PUT/v1/users/me/plan
Choose free, pro or business.
An upgrade is charged for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. The saved card is charged at once, in its currency. With no saved card, or when the card needs authentication or is declined, nothing is charged and the answer carries a checkout_url: a hosted page that charges the upgrade and saves the card. The plan changes once it is paid; one left unpaid lapses at expires_at.
A downgrade takes effect when the month ends, and next_plan names it until then. A contract plan is changed by asking us.
Request
Responses
- 200
- 400
- 401
- 409
- 502
- 503
The plan in effect and the one coming.
The request was malformed or failed validation.
Missing or invalid credentials.
A paid plan with nothing to charge now and no saved card for its statement (payment_method_required), or a contract plan (plan_by_contract).
The payment provider could not be reached (payment_provider_error).
Card payments are not available on this deployment (payments_not_configured), or the exchange rate for a card charged in reais could not be read (exchange_rate_unavailable); the plan is unchanged.