Users

Change the 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.

put/v1/users/me/plan

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/users/me/plan
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Request body

plan'free' | 'pro' | 'business' required

Response

The plan in effect and the one coming.

plan'free' | 'pro' | 'business' | 'enterprise' required

The plan in effect.

next_plan'free' | 'pro' | 'business' | 'enterprise' required

The plan from next month.

charged_usdnumber required

What the saved card was charged now; 0 when nothing was.

checkout_urlstring uri nullable required

The hosted page the upgrade waits on, which charges it and saves the card; null when nothing waits.

expires_atstring date-time nullable required

When an unpaid checkout_url lapses.

Example response

{
  "charged_usd": 24.5
}

Changes

No recorded changes to this operation across all 1 revision of this API.