Skip to end of metadata
Go to start of metadata


List of subscription services

Subscription products allow you to renew a license or service with customer at the end of every license period. Renewal happens by default upon expiry, unless you tell Nexway to cancel the subscription.

If you have any subscription products available, you can access the following additional API services:

1. Submitting subscription orders

Step 1.1: Check product stock (mandatory)

Nexway highly recommends checking product stock before you add a product to the customer cart (getStockStatus API).

In case no stock is available, the order is refused.

Step 1.2: Propose cross-selling, upselling, and options for a selected product (optional)

Optionally, you can get a list of product and options to add to the cart along with the initial product selected (getCrossUpSell API).
The following options are available:

  • Download extension
    By default, the end-user can download their products for 21 days after the purchase. Thanks to this option, the end-user can download a new copy of their product as many times as they want during the download time period.
  • Backup DVD
    A backup DVD of the products purchased will be sent to the end-user.

Step 1.3: Process the payment on your system (mandatory)

Leverage your own payment system to process the end-user’s payment for their purchases.

Step 1.4: Create the order (mandatory)

Once the payment has been accepted, you must submit the order to Nexway providing information about the product being purchased (createOrder API).
Depending on the API return code, the order is accepted or not. If accepted, a subscription ID is also returned.

Note: The real end-user email is requested in the order submission. For security reasons, some publishers send the information required to deliver and unlock the product directly to the end-user.

Step 1.5: Share the delivery information with the end-user

Three types of information must be sent to or shared with the end-user:

  • Nexway Order Number: Required for customer support
  • Serial Number: Unique product serial number provided by the publisher
  • Download information: Useful instructions to help the end-user to acquire and activate the product

2. Renewing subscriptions

Subscriptions will renew automatically upon expiry, unless cancellation is requested (see cancellation process below).

Step 2.1: Process the payment on your system (mandatory)

Process the payment on your system before the expiration date.

Step 2.2: Check that the subscription was created

Check the “Get Subscription Status” API on regular basis (we recommend doing so once every 4 hours) with our subscriptionID, as well as watching for an incremental change in the partner order number generation.
The partner order number is composed of your original partner order number (transmitted in step 1.4) and subscription generation, delimited with dash sign, for example:

  • Original partner order number: PARTNER689
  • Partner order number after first renewal: PARTNER689-1
  • Partner order number after second renewal: PARTNER689-2
  • (And so on.…)

Step 2.2: Get delivery information

When you see a change in the generated number, use your partner order number to call the “Get order data” API to get the order delivery information (such as the license number and activation key).

Step 2.3: Share the delivery information with the end-user

3. Canceling subscriptions

An end-user may wish to end (cancel) a subscription.

When cancelling a subscription through the "Cancel subscription" API:

  • The order will NOT be canceled.
  • The license remains active until the expiration date.
  • No renewal will take place upon expiry.

4. Canceling subscription orders

When you cancel an order containing a subscription product:

  • The license is canceled and the product becomes inactive immediately.
  • You will have to refund the end user.
  • No renewal occurs upon expiry.
  • No labels