Get plans available for purchase
This GET
operation retrieves the plans available to the specified subscriber for purchase. If successful, you receive an HTTP response code of 200
as well as a JSON
response body listing all of the plans available for purchase.
See HTTP response codes for other response codes. |
GET /pcc/spcm/subscribers/<msisdn>/plans/allowed
HEADER INFO
tenant: <tenantName>
authorisation: HTTP Basic Auth
accept: application/vnd.com.tango.pcc.v2+json
permissions: SPCM_PLAN_READ_PERMISSION
URL parameters
There is one mandatory parameter.
Parameter | Type | Description |
---|---|---|
|
string |
The subscriber’s MSISDN in international format. |
Query parameters
There are optional query parameters.
If you do not specify any query parameters, all fields are returned in the response. To use query parameters, simply add a ? followed by the parameter such as /pcc/spcm/subscribers/<msisdn>/plans/allowed?fields="name,cost" .
|
Parameter | Type | Description | ||
---|---|---|---|---|
|
comma-separated list |
Specifies the fields to be returned.
|
||
|
comma-separated list |
Filters by classification. |
||
|
integer |
Limits the results to plan definitions with a total cost of less than or equal to the specified value. |
||
|
string |
Sorts the returned plan definitions. Format: |
||
|
string |
Filters by location. |
JSON response
The following example response shows the expected response from passing a recognised msisdn
in the URL.
To see all possible fields for the plan definitions, see plan definition type descriptions. |
{
"planDefinition": {
"name": "SubscriberActivatedRecurringDataPlan",
"identifier": "qwerty4",
"unitAmount": "20",
"unitMeteringType": "volume",
"cost": "20",
"validityPeriod": "30days",
"classification": "DATA",
"precedence": "3",
"recurring": "true",
"core": "true",
"maxDeactivationCount": "3",
"recycleRollOverLimit": "0",
"accumulationPermitted": "false",
"dpsEnabled": "false",
"shared": "false",
"activationModeType": "default",
"validityCarryForward": "false",
"validityCarryForwardRankEnabled": "false",
"validityCarryForwardRank": "0",
"validityCarryForwardAccumulation": "false",
"deferredActivationAllowed": "false",
"loanPurchaseAllowed": "false",
"recommendationOnPurchase": "false",
"version": "1",
"totalCost": "22",
"description": "a great description!",
"allowed": false,
"grantedAmount": 555
}
}
Plan type descriptions
Field | Type | Description | ||
---|---|---|---|---|
|
integer |
The plan definition information for the plan.
|
||
|
integer |
Specifies the maximum number of times this plan can recur. options
|
||
|
string |
The unique identifier for the plan. |
||
|
enum |
The current state of the plan in its lifecycle. options
|
||
|
dateTime |
The time at which the plan was purchased.
|
||
|
dateTime |
The time at which the plan was activated.
|
||
|
dateTime |
The time at which the plan will expire.
|
||
|
dateTime |
The time at which the plan was updated.
|
||
|
boolean |
Flag that indicates if the plan has been cancelled. options
|
||
|
long |
The plan’s current usage. The unit type is defined in |
||
|
short |
The number of times the plan has been deactivated. |
||
|
string |
Identifies the source of the plan purchase such as |
||
|
string |
The current allowed plan amount (taken into account rollover, accumulation, and pro-rated data/validity). |
||
|
integer |
The number of times the plan recurred. |
||
|
enum |
The current usage state of the plan. options
|
||
|
dateTime |
The time when the plan was parked for the first time during the current renewal.
|
||
|
dateTime |
The time when the next retry will be made.
|
||
|
short |
The number of times the plan used the volume booster. |
||
|
short |
The number of times the plan used the validity booster. |
Plan definition type descriptions
Field | Type | Description | ||
---|---|---|---|---|
|
integer |
The unique identifier for the plan. This is assigned by the server upon creating a plan definition.
|
||
|
string (255) |
The name of the plan definition.
|
||
|
string (255) |
|||
|
enum |
Defines the unit type. This can be
|
||
|
integer |
The cost or purchasing the plan. Like
|
||
|
string (255) |
A formatted string that displays for how long a plan definition exists. An example is
|
||
|
string |
Denotes the hour, minute, and second at which the plan will expire or renew. NOTE: If not set, the plan will expire or renew relative to the purchase timestamp (timestamp + validity period). This format is |
||
|
integer |
The precedence of the plan over other plans purchased by the subscriber where
|
||
|
boolean |
Denotes whether a plan is recurring or not where
|
||
|
boolean |
Indicates if this plan is the core plan for the subscriber where
|
||
|
string (2048 char) |
A brief summary describing the plan. |
||
|
integer |
The amount of times a plan definition can be deactivated. |
||
|
integer |
The maximum number of times a recurring plan can recur. |
||
|
integer |
The maximum amount of unused data usage that can be carried forward when a plan is renewed.
|
||
|
boolean |
Indicates if accumulation is permitted where
|
||
|
boolean |
Indicates whether DPS is enabled where
|
||
|
boolean |
Indicates if a plan is activated upon purchase where
|
||
|
boolean |
Indicates if a plan is shared where
|
||
|
integer |
Denotes the version of the plan
|
||
|
integer |
Specifies the maximum number of recipients with whom quota can be shared.
|
||
|
integer |
The chunk size that is granted to a data session. The session reports usage after using the granted amount.
|
HTTP response codes
Code | Description | ||||
---|---|---|---|---|---|
|
success! |
||||
|
Multistatus response
|
||||
|
malformed request |
||||
|
unauthorised; bad username or password |
||||
|
forbidden; user does not have appropriate privileges |
||||
|
plan not found |
||||
|
conflict with target resource
|
||||
|
failed validation; this typically means that a property was not set or a value is out of range. example
|
||||
|
failed processing (after passing validation). example
|
||||
|
internal error |
||||
|
request rejected due to overload |