Update a plan

This endpoint allows merchants to update the attributes of an existing subscription plan. Only name, description, and tags can be modified - every other field (code, price, billing frequency, etc.) is immutable once the plan is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint is useful for adjusting details such as:

  • Prices
  • Tags
  • Terms of an existing plan.

The plan code cannot be modified.

Path Params
uuid
required

Internal identifier (UUID) of the plan to update.

Body Params

Only these three fields are accepted; any other field in the payload causes the request to be rejected.

string

New description for the plan.

string

New name for the plan.

tags
array of strings

New tags associated with the plan (replaces the existing ones).

tags
Headers
string
required

Authentication key used to access the API.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json