Activate a Plan

PATCH /subscriptionsplans/v1/plans/plan_id

Once you are satisfied with a plan you have created and you have finalized it, you must then activate the plan. A plan must have the status of ACTIVE before it can be used in a subscription for recurring payments from a consumer – by default, a plan has the status of INITIAL when you create it.

To activate a plan, you must initiate a PATCH request to the plans/plan_id endpoint, with the status element set to ACTIVE.

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?