Offer subscription

This GET operation obtains a subscription for a subscriber by passing the query parameters in the URL. The query parameters passed in the URL are retrieved via a JSON response if successful.

GET /gateway/plan/subscribe?<queryParameters>

Accept: application/JSON

Content-type: application/JSON


URL parameters

Parameter Description Required

msisdn

The subscriber’s MSISDN in international format.

yes

name

A string that defines the plan name or offer ID.

yes

source

String that defines the origin.

optional

recurrency

Boolean flag to specify if recurrency is enabled.

optional

promotion

Integer that rates the promotion factor.

optional

zone

String that specifies the subscriber zone.

optional

JSON response

The JSON response includes the information passed in the URL as a query parameter.

{
  "msisdn": "Tv6pDuPz2Gm1Gax0zl7a",
  "name" : "theOffer",
  "source": "theSource",
  "recurrency": false,
  "promotion": 0,
  "zone": "Mexico"
}