The Accumulus Subscription Commerce System allows you to fully automate the entire subscription life-cycle, including customer on-boarding and change processes. The information below is intended for developers wanting to integrate a company's website and backend servers with the Accumulus Subscription Commerce System, configure hosted pages to match the company's brand and customize notifications for an optimal customer experience. There are three sections:

API

The following diagram depicts a typical API-based signup interaction:

API Based Signup

After the customer fills in and submits the required signup information to the company's web server, a signup request is sent to the Accumulus API. In processing this request, the Accumulus system verifies the credit card, creates the customer and subscription records, and sends a welcome e-mail to the customer on behalf of the company. In addition to calling the API for creating a new signup, the API can also be used to create, update and retrieve various other data. Detailed information on the various API calls can be found here:

Provisioning Events

Once you have configured your provisioning endpoint within the administrative application (under Settings->Integration), your endpoint will be called when customer or subscription information changes, allowing you to automatically provision or de-provision the specified product(s) and/or service(s). An event is generated and transmitted to a configured server for provisioning purposes when any of the following has occurred:

  • A new subscription has been created
  • An existing subscription has been updated
  • The status of an existing subscription has changed
  • A new customer has been created
  • An existing customer has been updated
  • The status of an existing customer has changed
  • A Ping event has been manually triggered

The following diagram depicts the provisioning event flow:

Provisioning Events

For detailed information about the individual provisioning events, click here.

Hosted Pages

Hosted pages allow you to get to market very quickly without any need for programming. Hosted pages provide the following functionality:

Hosted signup pages can be standalone or integrated into an existing site via an iFrame. Below is an example of the a hosted signup page integrated into an existing site via an iFrame:
Accumulus Hosted Signup

For more information on how either hosted signup or hosted customer portal pages, click the corresponding link at the top of this section.

Notifications

You can configure notifications to be sent to your customers at different times in the subscription lifecycle. For example, a welcome e-mail may be sent when a customer signs up and a cancellation e-mail may be sent when a subscription is cancelled. The Accumulus notification system uses editable templates to allow you to fully customize the contents of these notifications.

The templates contain both the text for the notification and tokens which are replaced with your company and customer data when generating the notification. This is analogous to a mail merge in which certain parts of a message are filled in with customer specific information. Each notification template has a number of tokens which are relevant to the notification. Tokens are identified by placing a "$" at the beginning and the end of the token name. For example $CustomerName$ is the token that will be replaced with the actual customer name when generating the notification. Below is a list of the notification templates and by following the links, you can find the associated tokens for each.

Refer to the advanced template topics page for information on advanced template control flow such as looping as well as formatting of tokens.