Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Billing plans · Update a plan
API reference / Billing plans

Update a plan

PUT/api/v1/billing_plans/:idbilling:write

Change a plan's name, price or status. Archive it with status 3.

Path parameters

idintegerrequired

The plan's ID.

Body

namestring

New name.

flat_ratenumber

New price per cycle.

descriptionstring

New description.

statusinteger

1 active, 2 draft, 3 archived.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

The updated plan, with 201.

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.
422A field is wrong.