Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Media Publishing Suite > Aria Media and Publishing Suite (AMPS) - Subscription Management

Aria Media and Publishing Suite (AMPS) - Subscription Management

This article applies to:Aria Crescendo

Overview

The Subscription Management component of AMPS provides functionality to handle individual subscriptions as well as campaigns and bundles. Both consumer and business subscriptions are supported. Subscription Management provides the following major capabilities:

  • Subscriptions – a subscription defines the product purchased by the customer, and which are billed with regular intervals. The subscription defines the product purchased, the billing frequency and what rates to apply. A subscription is usually linked to a single title. A subscription may also represent a bundle that provides access to multiple titles. It is possible to cancel active subscriptions, if required. 
  • Campaigns – when creating new subscriptions, the customer may be eligible for a campaign, and if selected, the campaign will be billed separately, and when the campaign is complete, the subscription continues on normal terms. 
  • Bundles – when purchasing a product, the customer may be eligible for a bundle consisting of multiple services and titles, for example if the customer already has a number of active subscriptions. The customer may choose the bundle over the normal subscription and thereby get access to the additional services for a given price. 
  • Upgrade/Downgrade – when working with subscriptions it is possible to define an upgrade or downgrade path for each product. With this path the customer can chose to upgrade or downgrade the subscription at any time. Before the upgrade/downgrade takes place all pre-requisites for the purchase will be checked. 
  • Offerings – as part of the sales journey AMPS is able to provide a list of eligible products the customer may purchase. The offerings are dependent on whether the customer is known or unknown. Bundles and discounts are provided only for known customers. 

Other functionality may be added in the future as requirements change. 

Subscription Management

The Subscription Management component consists of the services, reports and sub-flows shown in the below diagram.

Subscription Management.jpg

Each of the services, reports, and processes in support of this functionality is shown below:

Manage Subscriptions [SubsManageSubscriptions]

"Manage Subscription" is a service used to add, remove and modify subscriptions assigned to an account.  The subscriptions are linked to the account, billing group and payment methods managed by the Account Management component.

Retrieve Subscriptions [SubsRetrieveSubscriptions]

"Retrieve Subscriptions" is a service used to retrieve all subscriptions registered for an account, and the details of those subscriptions. The details returned include subscriptions details, previous charges, billing details, dunning details, delivery addresses, title information, etc. 

Change Billing Day [SubsChangeBillingDay]

"Change Billing Day" is a service used to adjust the billing day of one or more of a customer's subscriptions. When changing the billing day, the necessary adjustment is made to the charges for those subscriptions.

Get Eligible Offerings [SubsGetEligibleOfferings]

"Get Eligible Offerings" is a service used to retrieve the offerings eligible for a given customer at the time of request. The result set depends on whether the customer is known at the time of the request, or whether they are not logged in. The service returns the offerings, including campaigns and bundles, where titles, segmentation and other restrictions are met. If the customer is known when the API is called, the API will return all products which the customer is eligible to purchase, taking into consideration any existing subscriptions. When the customer is known bundles and discounts are also checked for eligibility. If the customer is NOT known when the API is called, the API will return all products which the customer is eligible to purchase, given the fact that no other information is known on the customer. Bundles and Discounts are never returned in this situation. 

Build Offering Plan [SubsBuildOfferingPlan]

"Build Offering Plan" is a sub flow used to build and format the response containing eligible offers. This sub flow builds the default product list that match the criteria, and later this result set is augmented with information on campaigns, discounts and bundles. 

Price Model Checker [SubsPriceModelChecker]

"Price Model Checker" is a batch process that is run daily to check if any of the special price model products needs attention. The process will analyze each subscription on this kind of product and perform the necessary update to ensure the right price is always assigned. 

Handle Price Model [SubsHandlePriceModel]

"Handle Price Model" is a sub flow that creates the necessary definitions to apply a given price model to a subscription. Will be used both when creating new subscriptions and when checking whether it is necessary to make any updates to the price model already applied. 

Manage Individual [SubsManageIndividual] 

"Manage Individual" is a service used to add, remove and modify individuals assigned to a business product with product type variant "INDV-DELIVERY" or "INDV-REGISTRATION".  The service creates and manages the supplemental plan instances under the main product. The subscriptions are linked to the master plan instance, account, billing group and payment methods managed by the Account Management component.

Retrieve Individual [SubsRetrieveIndividual]

"Retrieve Individual" is a service used to retrieve all individuals registered for a master plan instance having product type variant "INDV-DELIVERY" and "INDV-REGISTRATION" and an account. The details returned include subscriptions details, delivery details, etc. 

Manage Cancellation Reasons [SubsManageCancelReason] 

"Manage Cancellation Reasons" is a service used to add, remove and modify cancellation reasons used when cancelling subscriptions. 

Retrieve Cancellation Reasons [SubsRetrieveCancelReason]

"Retrieve Cancellation Reasons" is a service used to retrieve all cancellation reasons registered in the system. The cancellation reasons are used when cancelling subscriptions. 

Check Restriction [SubsCheckRestriction]

"Check Restriction" is a service used to validate if all purchase restriction for a given plan / product has been fulfilled by the end-customer. If not, the purchase is not allowed. 

Manage Cancellation [SubsManageCancellation]

"Manage Cancellation" is a subflow that implements the cancellation process required by the client. It is possible to cancel immediately, at anniversary or on a specific date. Processing varies depending on the billing and subscription configuration. 

Retrieve Change Options [SubsRetrieveChgOptions]

"Retrieve Change Options" is a service used to retrieve the potential upgrade and downgrade paths for a given subscription. The service returns the detail on plans to which the customer and upgrade or downgrade include the cost associated with the change. 

Validation Subscription [SubsValidateSubscription]

"Validate Subscription" is a service used to validate and check the consequences of the customer making an upgrade or downgrade. The service calculates the additional charges, lesser charges and the difference between the subscriptions. 

Process Future Actions [SubsProcessFutureActions]

"Process Future Actions" is a batch process that is run every 10-15 minutes or so to check if scheduled actions must be handled. The process will handle actions such as ….

  • Produce Final Invoice
  • Cancellation
  • Delivery Stop
  • Contract End

Manage Subscription Discounts [SubsManageDiscounts]

"Manage Subscription Discounts" is a JSON service used to add, modify or remove discounts from a given subscription. The discounts are assigned using the referenced coupon in ARIA. 

Retrieve Subscription Discounts [SubsRetrieveDiscounts]

"Retrieve Subscription Discounts" is a JSON service used to retrieve the current list of discounts assigned to a given subscription. Details on the discount is also returned. 

Note: See "Interface and Integration Definitions for Subscription Management" for the API methods used for Subscription Management when integrating with AMPS.

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.