Change End Date or Cancel Subscription

A subscription's end date can be modified either by changing the end date to an earlier date or by canceling it immediately.

Back Office UI

Change the End Date of a Subscription

  1. Click the Recurring menu item.
  2. Click the Subscriptions tab.
  3. Select the subscription whose end date you want to change. The corresponding subscription info appears.
  4. Click the Actions button, then select Change End Date. The Change Subscription End Date window appears.
  5. Enter the New End Date. You may also click the calendar icon to select the date. Note that the new end date cannot be later than the current end date.
  6. Review the updated fields and click the Save Changes button to save the new end date.
If the subscription you have selected was previously modified, the Remove early end date option will be available. You can select this option instead of entering a new date to reinstate the original end date that the subscription had.

Cancel a Subscription

  1. Click the Recurring menu item.
  2. Click the Subscriptions tab.
  3. Select the subscription that you want to cancel. The corresponding subscription info appears.
  4. Click the Actions button, then select Cancel Subscription. A confirmation dialog box appears.
  5. Click the Cancel Subscription button to proceed with the cancellation.

Change the End Date or Cancel a Subscription from a Customer's Profile

  1. Click the Customers menu item.
  2. Select the customer associated with the subscription. The corresponding customer profile appears.
  3. In the Subscriptions section, select the subscription whose end date you want to change or cancel. The corresponding subscription info appears.
  4. See steps 4 to 6 under Change the End Date of a Subscription section or steps 4 to 5 under Cancel a Subscription section.

API Integration

Converge API Resource: Subscriptions

Update Subscription

  1. Send an Update Subscription POST request to /subscriptions/{id}, where id is the subscription's resource id. An example of a complete URL where to send the request is https://uat.api.converge.eu.elavonaws.com/subscriptions/dtdfj7bg8jbj86jcd63c66fm949p.
  2. In your request, set the following parameter:
    • cancelAfterBillNumber - The bill number after which no further billings will occur. If the value set for this field is equal to the current bill number, the subscription will be cancelled immediately.
  3. Wait for the response from the /subscriptions endpoint.

Examples

The following is an example of a JSON request for cancelling a subscription after the first bill.

POST "https://uat.api.converge.eu.elavonaws.com/subscriptions/dtdfj7bg8jbj86jcd63c66fm949p"
{
    "cancelAfterBillNumber": 1
}

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

{
    "href":  "https://uat.api.converge.eu.elavonaws.com/subscriptions/dtdfj7bg8jbj86jcd63c66fm949p",
    "id":  "dtdfj7bg8jbj86jcd63c66fm949p",
    "createdAt":  "2022-04-04T20:02:17.178Z",
    "modifiedAt":  "2022-04-04T20:15:05.497Z",
    "merchant":  "https://uat.api.converge.eu.elavonaws.com/merchants/XrDXRBh9YHxwqQTj2Cmq7j49",
    "plan":  "https://uat.api.converge.eu.elavonaws.com/plans/ry2t4kh4gkrk3h7vq9wx36794gvp",
    "shopper":  "https://uat.api.converge.eu.elavonaws.com/shoppers/pbrcccxy9pgk4qfdcbhf88w97hxv",
    "account":  "https://uat.api.converge.eu.elavonaws.com/accounts/XrDXRBh9YHxwqQTj2Cmq7j49",
    "debtorAccount":  null,
    "doSendReceipt":  "true",
    "storedCard":  "https://uat.api.converge.eu.elavonaws.com/stored-cards/g9fw9kg2fjfcdm62rb2f38cqmx9m",
    "billCount":  12,
    "timeZoneId":  "Europe/London",
    "firstBillAt":  "2022-04-22",
    "nextBillAt":  "2022-04-22",
    "previousBillAt":  null,
    "finalBillAt":  "2022-04-22",
    "cancelRequestedAt":  "2022-04-04",
    "cancelAfterBillNumber":  1,
    "nextBillNumber":  1,
    "subscriptionState":  "active",
    "failureCount":  0,
    "customReference":  null,
    "customFields":  null
}

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