This page provides Business administrators a user guide for the Subscription microservice for the Infosys Equinox Commerce platform.

Page Contents

Getting Started

Overview

Accessing the Subscription Console

The Subscription microservice allows users to subscribe to products that are purchased frequently or at regular intervals of time. It provides a Subscription admin to view, search, and cancel the subscription requests.

For a detailed overview of the Subscription microservice, see the Subscription Microservice Overview.

Service Glossary

Business – the parent of a store or set of stores. The basic use of a business is to manage common sets of users, catalogs, and other services for the stores associated with the business.
Business Admin – a role that manages business settings, creates and manages stores, and enables microservice(s) for a business.
Customer– a business consumer or buyer on the Business’ B2B storefront.
Product – a good, service, or idea that has a combination of tangible and intangible attributes and can have multiple variants which are referred to as stock keeping units (SKUs). In Infosys Equinox Commerce, the consumer/buyer evaluates a product (for example, a men’s dress shoe available in black and brown and in sizes from 10 to 15), but actually purchases a SKU associated with the product (for example, a black colored version of the dress shoe in size 12) rather than the product itself.
Stock Keeping Unit (SKU) – a particular variant of a product which is available for purchase by a consumer/buyer.
Store – represents a specific physical location or online store of a business.
Storefront – a consumer-facing website that presents products, content, and promotions across multiple channels such as desktop, tablet, and mobile.
Subscription – collects a recurring payment in exchange for recurring product deliveries or on-going service.
Subscription Admin – manages subscription requests.

Prerequisites for Setting Up Subscriptions

top | Accessing the Subscription Console

Before you start,

ensure that you have valid credentials to access the Subscription Admin console.
set up the subscriptions related store properties, in the Foundation Admin Console under the Advanced tab of the Store Overview page. For more information, see Foundation Admin Guide.
configure the collection properties, in the Foundation Admin Console.
enable Subscription for a product in the Catalog Service.

Accessing the Subscription Console

Setting Up Subscriptions | Configuring Search Parameters

To access the Subscription console,

Log in to the Foundation server for your business (URL provided by Infosys Equinox).
Click Subscription in the StoreOps page.

The Subscription landing page appears:

Configuring Search Parameters

Accessing the Subscription Console | Managing Subscriptions

In the Subscriptions page, you can search the subscription request(s) based on Subscription ID, E-Mail, SKU ID, SKU Name, and/or Subscription request date, modify the search fields in the header, and modify the appearance of the subscription request rows per screen.

Search for Subscription Requests

To search for subscription requests,

Click the Subscription Id, E-Mail, SKU ID, or SKU Name drop-down list in the header to open an entry field to provide search criteria.
Note: For displaying a predefined number of subscription requests per screen, see Selecting Predefined Rows.
Enter the desired search criteria in the search field, and then click Go:

The subscription request(s), which matches the search criteria appears:

Modifying Searchable Fields

Searching for Subscriptions | Selecting Predefined Rows

To modify the searchable fields,

Click the vertical ellipse available at the beginning of the search field.
Select or deselect the items to add or remove the searchable fields in the header:

The selected searchable fields appear in the header:

Selecting Predefined Rows

Modifying Searchable Fields | Managing Subscriptions

By default, 10 subscription requests per screen will appear, but the number of subscription requests per screen can be modified as follows:

Click the vertical ellipse available at the beginning of the search field.
Select Row Select. The Row Select appears as part of the search criteria.
Select 10 Rows, 25 Rows, or 50 Rows from the drop-down list.
Click the Go button. The selected rows of subscription request appear in the screen.
Note: To reset the search field in the header, click the Reset button.

Managing Subscriptions

Selecting Predefined Rows | Viewing Subscriptions

The first order of any subscription is manually placed by the customer. The subsequent subscription orders are automatically placed as recurring orders using the feeds.

A subscription admin can,

view the subscription request
cancel a subscription
skip the next order
change the item quantity and order frequency
view the subscription orders

Viewing the Subscription Requests

In the Subscriptions homepage page, you can

view a list of subscription requests
search for subscription requests

To view a Subscription Request,

In the All Subscriptions page, you can view all the subscription requests.
Note:
- Pagination option appears in all screens that contain the subscription request data.
- To navigate to the next page, click Next.
- By default, 10 subscription requests per screen will appear.
In the All Subscriptions page, click the desired subscription request.

The Overview page displays the detailed summary of the subscription request.

Note:
- You can navigate to the respective Customer’s overview page directly by clicking on the Customer Id.
- You can update a subscription request using the edit icon.

Editing a Subscription Request

Editing a Subscription | Cancelling a Subscription

You can update the subscription details such as item quantity and order frequency details based on customer’s request.

To update a subscription detail for a customer,

In the All Subscriptions page, click against the desired subscription request.
The subscription details appear
Note: You can navigate to the respective Customer’s overview page directly by clicking on the Customer Id.
Click at the subscription overview section.
The subscription overview edit section appears
In the subscription page, you can,
- Click on the Frequency field and select the required frequency.
  Note: The Frequency values that are defined in the collection properties page appears here.
- In the Quantity field, specify the required number of items.
Click the Save button to update the subscription.
Note: For detailed information on the other fields, refer to the Create a Subscription section in the Customer’s admin guide.

Skipping the Next Order

Editing a Subscription | Cancelling a Subscription

In the Subscriptions page, upon customers’ request a Subscription Admin can skip or unskip the next order of an active subscription request.

To skip the next order,

In the Subscriptions home page, click on a subscription of a customer.

The subscription details appear:
In the Subscription page, click the edit icon.
In the Subscription’s Overview section page, click the Skip Next Order button.

Note: After skipping the next order, you can Unskip the order by clicking the Un skip Next Order button. For more information on skipping the next order from the customer’s page, refer to the Customers Admin Guide.

Canceling a Subscription

Skipping the Next Order | Viewing the Subscription Order

As a Subscription Admin, you can cancel a subscription created by a customer.

To cancel a subscription on behalf of a customer,

In the Subscriptions home page, click the desired subscription request.
In the Subscription details page, click the edit icon.
In the Subscription’s Overview section page, click the Cancel Subscription button to cancel the subscription.
In the Subscription cancel pop-up, click Confirm.
The subscription request is canceled, and status of the subscription request is changed to CANCELED.
The All Subscriptions page displays the Canceled status.

Viewing the Subscription Orders

Cancelling a Subscription | Revision History

In the Subscriptions page, you can view the list of orders for a subscription request.

To view the subscription orders,

In the Subscriptions home page, click on a required subscription.
In the subscription details page, click the Orders tab in the left navigation panel.

The subscription orders are listed.