Subscription events

Use the Digital River Subscription service to receive an immediate notification of important subscription lifecycle events. These notifications inform you when customers create, convert, renew, or cancel subscriptions.

The Subscription service is an outbound event.

In the following diagram, a customer purchases a new subscription to a product. You receive the notification when the customer creates a new subscription. After the trial period expires, the system bills the customer and you receive a trial to active conversion notification. As the customer continues to use the product, you receive renewal notifications at the start of every new subscription period. Finally, when the customer no longer needs the product and their subscription lapses, you receive a cancellation notice.

Subscription Timeline

Subscription acquisition

Trigger: When a customer purchases a new subscription.

During the shopping experience, a customer orders a subscription to one of your products. They may order a trial subscription or a purchased subscription.

On successful creation, Digital River generates a New Subscription Notification request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a New Subscription Notification response.

See New subscription example for an example.

Subscription renewal

Trigger: When an existing subscription renews (either auto or manual).

At the end of a subscription period, the shopper must renew the subscription for continued access to the product. A shopper can accomplish a renewal in two ways:

  • Automatic Renewal (Auto Renew)–The shopper provides a payment method that system automatically debits a specified number of days before the subscription expiration date. If the renewal fails because the billing information is not correct (for example, an expired credit card) shoppers are notified and given a chance to update their billing information. The system will attempt to bill a shopper for automatic renewals several times before we cancel the subscription and list the billing attempt as failed.

  • Manual Renewal–The shopper receives emails at preconfigured time intervals before the expiration date that asks the shopper to complete a renewal transaction. The shopper has to renew the subscription manually. The customer can choose one of the following options to renew their product:

    • Log in to their My Account portal and renew using the features available in the self-service options.

    • Call Customer Service to renew the subscription.

In either case, the system renews the subscription the payment is complete.

On renewal, the system generates a Subscription Renewal Success Notification Request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Subscription Renewal Success Notification Response.

See Subscription renewal example for an example.

Changing the quantity

Trigger: When a customer changes the quantity of an active subscription.

A customer can use the My Account pages to change the number of subscriptions they own for a product. On a successful change of quantity, the system generates a Change Quantity request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Change Quantity response.

Changing the number of units

Trigger: When a customer changes the number of units associated with an active subscription.

A user or Customer Service can change the number of units for a subscription.

Changing the expiration date

Trigger: When the expiration date of the active subscription changes.

There are several ways to change the expiration date for the current subscription period:

  • Subscription Renewals—When the subscription is renewed, you are notified of the new end date for the subscription.

  • Customer Service Intervention—If allowed by the API consumer (also known as the client), Customer Service may extend the subscription end date for customer satisfaction reasons.

  • Client Direction—Indicates whether the API consumer may direct the system to modify the Expiration Date using the Modify Renewal Date Request.

  • Post Activation—If the API consumer maintains the activation of the subscription after the subscription is activated, the system sends notification of the new expiration date.

  • Subscription Suspension—If the API consumer creates, modifies, or ends a suspension to a subscription using the Modify Suspension Request, the system sends notification of the new expiration date.

On a successful change, the system generates a Change Expiration Date request and sends it to your endpoint.

Requirement: Your endpoint must synchronously respond with a Change Expiration Date response.

See Change subscription expiration date for an example.

Cancellation

Trigger: When a subscription is cancelled.

A subscription cancellation occurs when:

  • A customer directly cancels their subscription via My Account or Customer Service.

  • A subscription fails to renew and the grace period (if one exists) expires.

  • The subscription fails to convert from a trial to active.

On cancellation, the system generates a Cancel Subscription request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Cancel Subscription response.

See Cancel subscription request example for an example.

Auto to manual billing

A customer can use the My Account pages to disable automatic billing. When the customer disables automatic billing, the customer must manually enter the payment details every time they renew their subscription.

On a successful change, the system generates a Convert Auto to Manual Billing request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Convert Auto to Manual Billing response.

See Convert auto to manual billing example for an example.

Manual to auto billing

A customer can use the My Account pages to enable automatic billing. When a customer enables automatic billing, the system automatically debits the renewal cost from the customer's chosen payment method.

On a successful change, the system generates a Convert Manual to Auto Billing request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Convert Manual to Auto Billing response.

See Convert auto to manual billing example for an example.

Trial conversion

If a customer does not cancel their subscription during the trial period, the system automatically converts the subscription from trial to active. When the system charges the customer, a trial-to-active conversion occurs. If a payment method is immediately declined, the system notifies the customer via email of the payment failure. If the customer fails to remedy the payment situation, you receive a Cancel Subscription notification.

On successful conversion, the system generates a Convert Trial Subscription request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Convert Trial Subscription Notification response.

See Convert trial subscription example for an example.

Revoke trial conversion

If a customer does not cancel their subscription during the trial period, the system automatically converts the subscription from trial to active. Unfortunately, with certain payment types (such as direct debit), the system will not receive funds or notification of unavailability of the funds for several days. To give the best possible experience to the customer, the system assumes successful conversion and generates the Trial Subscription Successfully Converted notification. If the system later receives notification that the payment was declined, the system alerts you that the conversion is revoked. This is a compensating transaction for the previous notification.

When a conversion fails, the system generates a Revoke Trial Subscription request and sends the request to your endpoint.

Requirement: Your endpoint must synchronously respond with a Revoke Trial Subscription response.

Schemas

Version

Schema Components Table

Raw Schema

Sample XML

30 (Current)

View

View

Not available

29

View

View

Not available

28

View

View

Not available

27

View

View

Not available