Update a Plan

PUT /subscriptionsplans/v1/plans/plan_id

You can update an existing plan, with some limitations. For example, once a plan is ACTIVE, you cannot modify the amount, since this would affect any subscription you have set up with this plan.

When a plan has the status of INITIAL, you can modify any of its elements. However, once a plan has the status set to ACTIVE, you can modify only the following elements:

  • name
  • description
  • endDate
  • status (for an ACTIVE plan, this can be modified only to INACTIVE)

Any nullable element that is part of an existing plan but that is not included in the update PUT request will be set either to null or to the default value if it has one.

To update a plan, you must initiate a PUT request to the plans/plan_id endpoint.

Before trying the example, you should:

  • Replace the plan ID (e067d83f-add7-4b6b-8884-dfa8693dde1f) with the id you received in the response to your plan creation request.
  • Replace the API key (after the -u) with the Test API key you have received.

For a description of the elements in the request and response for this example, see Create a Plan.

For a complete list and description of the elements and values associated with a plan, consult the plan creation API request.

Did you find this page useful?