Skip to end of metadata
Go to start of metadata

List of subscription services

Products with subscription allow you to renew the service with customer every licence duration period. Renewal will happen by default upon expiry, unless you inform us to cancel the subscription.

If you have any subscription product available, you will access the following additional API services:

  • Get subscription status
  • Cancel subscription

1. Order submission

Step 1.1: Check product stock (mandatory)

Nexway highly recommends to check Product stock before adding a product in the customer cart (getStockStatus API).

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

Step 1.2: Propose cross sales, up sales and options for a selected product (optional)

Optionally, you can get a list of product and options to be added in the cart in addition of the initial product selected (getCrossUpSell API).
Available options are the followings:

  • Download extension
    By default, end-user can download their products during 21 days after the purchase. Thanks to this option, End-user can download a new copy of their product as many times as they want during the new 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 payment of the purchase by the end-user.

Step 1.4: Create the order (mandatory)

Once the payment has been accepted, you must submit the order to Nexway providing information regarding the product being purchased (createOrder API).
Depending on API return code, the order is accepted or not. A subscriptionId will also be returned.

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

Step 1.5: Share the delivery information to the end user.

Three information must be sent/shared with the end-user:

  • Nexway Order Number: required for customer support
  • Serial Number: product unique serial number provided by the Publisher
  • Download information: Useful instruction to help the end user to get and activate the product

2. Subscription renewal

Subscription will renew automatically upon expiry, unless cancellation is requested. Process for requesting cancellation is documented further below.

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

Process the payment on your system before expiration date.

Step 2.2: Check if subscription is created

Poll the "Get Subscription Status" API on regular basis (once every 4h recommended) with our subscriptionId and watch for increment in partner order number generation.
Partner order number is composed of your original partner order number (transmitted in step 1.4) and subscription generation, delimited with dash sign, i.e.:

  • original partner order number: PARTNER689
  • partner order number after first renew: PARTNER689-1
  • partner order number after second renew: PARTNER689-2
  • and so on..

Step 2.2: Get delivery information

Upon change in generation number stop polling "Get subscription status" API and call the "Get order data" API with your partner order number to get the order delivery information (i.e. licence number, activation key).

Step 2.3: Share the delivery information with end user.

3. Subscription cancellation

End user may wish to end (cancel) a subscription.

When cancelling a subscription through "Cancel subscription" API:

  • the order will NOT be cancelled
  • the licence will remain active, until the expiration date
  • no renew will take place upon expiry

4. Order cancellation

When cancelling an order containing a subscription product:

  • the licence will be cancelled and become inactive immediately
  • you will have to refund the end user
  • no renew will occur upon expiry
  • No labels