Mobile subscription order service

Summary

Mobile subscription order service API gives info about available packages and products and allows ordering them for both new and existing mobile subscriptions.

Glossary

  • Product - general term for any VAS or package
  • VAS (value added service) - a product or service that can be activated or ordered for a subscription
  • Package - main package for a subscription for phone calls, SMSes and data connection
  • Feature package - a combination of packages - call, SMS and data
  • Offer - a combination of products offered to a subscription. Offer is active if some product from the offer is activated or ordered for a subscription.

Authentication

  • Resources are protected using oauth2
  • To start using APIs, consumer should authenticate, retrieve bearer token and include it in subsequent requests
  • For More Authentication Information, Please Click Authorize Button, It's next to servers url.

Usage scenarios

Open a new subscription:

  • Query available packages for new subscription and choose one package - GET /customers/{customerCode}/packages/new
  • Optionally query available VAS offers for new subscription and choose one or more - GET /customers/{customerCode}/packages/new/offers
  • Order a new subscription with the chosen package and VAS product codes and parameters - POST /customers/{customerCode}/subscriptions

Order a new VAS for an existing subscription:

  • Query available offer groups - GET /subscriptions/{msisdn}/offerGroups
  • Query products configuration for the chosen offer - GET /subscriptions/{msisdn}/offerGroups/{group}/offers
  • Order new product configuration for the offer - POST /subscriptions/{msisdn}/offers/{offerId}

Change package of an existing subscription:

  • Query available packages - GET /subscriptions/{msisdn}/offerGroups/packages
  • Query available Subscription Type Change packages - GET /subscriptions/{msisdn}/subscriptionTypeChangePackages
  • Order new package - POST /subscriptions/{msisdn}/offers/{offerId}

Get a list of active/orderable offers for an existing subscription:

  • Query available offer groups - GET /subscriptions/{msisdn}/offerGroups

Get products configuration for an offer for an existing subscription:

  • Query products configuration for the chosen offer - GET /subscriptions/{msisdn}/offerGroups/{group}/offers

Get products configuration for an offer for an existing subscription:

  • Query products configuration for the chosen offer - GET /subscriptions/{msisdn}/offerGroups/{group}/offers.