Change Subscription Email Settings

A subscription's email settings can be changed whether receipts for every transaction need to be emailed to the customer.

Back Office UI

Change the Email Settings of a Subscription

  1. Click the Recurring menu item.
  2. Click the Subscriptions tab.
  3. Select the subscription whose email settings you want to change. The corresponding subscription info appears.
  4. Click the Actions button, then select Edit Subscription. The Edit Subscription window appears.
  5. Select or deselect the Email Receipt checkbox. If selected, a separate receipt will be emailed for each transaction.
  6. Click the Save Changes button to save the new email settings.

Change the Email Settings of 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 email settings you want to change. The corresponding subscription info appears.
  4. See steps 4 to 6 under Change the Email Settings 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. Below is an example of a complete URL where to send the request:
    • https://uat.api.converge.eu.elavonaws.com/subscriptions/dtdfj7bg8jbj86jcd63c66fm949p
  2. In your request, set the following parameter:
    • doSendReceipt - If set to true, receipt for every transaction will be sent to the customer's email. If set to false, receipts will not be emailed.
  3. Wait for the response from the /subscriptions endpoint.

Examples

The following is an example of a JSON request to send all transaction receipts to the customer's email.

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

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:17:48.085Z",
    "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.