post/billing/change-plan

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/billing/change-plan
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

tier'free' | 'starter' | 'growth' required

Target tier to switch to (enterprise handled via contactEnterprise)

Response

OK

status'upgraded' | 'downgraded' | 'scheduled' | 'no_change' | 'error' required

Result of the plan change operation

messagestring required

Human-readable result description

scheduledDatestring date-time nullable required

For downgrades: ISO 8601 date when the change takes effect

Changes

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