Skip to main content
POST
Change Wix plan

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Headers

Idempotency-Key
string

A key you generate for this plan change. Send the same key when you retry it, and a new one for every other change.

Required string length: 8 - 100

Body

application/json
new_product_id
string
required

Wix product of the plan to move to, from wix_product_id in List plans.

Required string length: 1 - 100
Example:

"5f0c7a2e-3b91-4d6a-9e0f-2c8b1d4a7e63"

period_unit
enum<string>
required

Billing period of the new plan: MONTH or YEAR.

Available options:
MONTH,
YEAR
Example:

"MONTH"

Response

The upgrade was charged, or the downgrade scheduled.

The outcome of a Wix plan change.

success
boolean
required

Always true. A failure returns an error status instead.

Example:

true

is_downgrade
boolean | null

true when the change is a downgrade scheduled for the end of the billing period. Not returned on an upgrade.

Example:

true

invoice_id
string | null

ID of the invoice the upgrade was charged on. Not returned on a downgrade.

Example:

"2025-0001234"