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.
Request Example
curl -X PATCH https://api.test.paysafe.com/subscriptionsplans/v1/plans/e067d83f-add7-4b6b-8884-dfa8693dde1f \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json' \
  -d ' {
	"status": "ACTIVE"
} '
Response Example
{
	"id": "e067d83f-add7-4b6b-8884-dfa8693dde1f",
	"version": 1,
	"name": "Gold Plus",
	"description": "Gold Plus plan for Elite members",
	"amount": "8500",
	"currencyCode": "USD",
	"billingCycle": {
		"frequency": "MONTHLY",
		"interval": "1"
	},
	"startDate": "2018-03-01",
	"endDate": "2019-03-31",
	"status": "ACTIVE",
	"creationTime": "2018-02-14T15:12:18Z",
	"lastUpdatedTime": "2018-02-15T15:12:18Z",
	"links": [{
			"rel": "self",
			"href": "https://api.test.paysafe.com/subscriptionsplans/v1/plans/e067d83f-add7-4b6b-8884-dfa8693dde1f"
		},
		{
			"rel": "subscriptions",
			"href": "https://api.test.paysafe.com/subscriptionsplans/v1/plans/e067d83f-add7-4b6b-8884-dfa8693dde1f/subscriptions"
		}
	]
}

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?