Lock and Unlock Plan

A plan can be locked to prevent new subscriptions from being added and to prevent cancelled subscriptions from being reactivated. Locking plan does not impact currently active subscriptions.

Back Office UI

Lock a Plan

  1. Click the Recurring menu item.
  2. Click the Plans tab.
  3. Select the plan that you want to lock. The corresponding plan info appears.
  4. Click the Actions button, then select Lock Plan. A confirmation dialog box appears.
  5. Click the Lock Plan button to proceed.
To unlock a plan, repeat the same steps and select Unlock Plan instead on step 4.

API Integration

Converge API Resource: Plans

Update Plan

  1. Send an Update Plan POST request to /plans/{id}, where id is the plan's resource id. Below is an example of a complete URL where to send the request:
    • https://uat.api.converge.eu.elavonaws.com/plans/ry2t4kh4gkrk3h7vq9wx36794gvp
  2. In your request, set the following parameter:
    • isSubscribable - If set to true (default), new subscriptions can be added to the plan. Cancelled subscriptions can also be reactivated. If set to false, new subscriptions cannot be added and cancelled subscriptions cannot be reactivated.​
  3. Wait for the response from the /plans endpoint.

Examples

The following is an example of a JSON request to lock a plan.

POST "https://uat.api.converge.eu.elavonaws.com/plans/ry2t4kh4gkrk3h7vq9wx36794gvp"
{
    "isSubscribable": false
}

The following is an example of a successful JSON response to the request above.

{
    "href":  "https://uat.api.converge.eu.elavonaws.com/plans/ry2t4kh4gkrk3h7vq9wx36794gvp",
    "id":  "ry2t4kh4gkrk3h7vq9wx36794gvp",
    "createdAt":  "2022-04-04T19:52:00.274Z",
    "modifiedAt":  "2022-04-04T20:11:53.678Z",
    "deletedAt":  null,
    "merchant":  "https://uat.api.converge.eu.elavonaws.com/merchants/XrDXRBh9YHxwqQTj2Cmq7j49",
    "planList":  "https://uat.api.converge.eu.elavonaws.com/plan-lists/XrDXRBh9YHxwqQTj2Cmq7j49",
    "name":  "Monthly Software License",
    "description":  null,
    "billingInterval":  {
                            "timeUnit":  "month",
                            "count":  1
                        },
    "total":  {
                  "amount":  "5.00",
                  "currencyCode":  "EUR"
              },
    "billCount":  12,
    "initialTotal":  {
                         "amount":  "2.50",
                         "currencyCode":  "EUR"
                     },
    "initialTotalBillCount":  1,
    "shopperStatement":  null,
    "isSubscribable":  false,
    "customReference":  null,
    "customFields":  null
}

For more request and response examples, and for the complete and detailed list of parameters, see the Plans resource.