Apply booster to a plan

This POST operation applies a booster to an existing subscriber plan which can increase volume or validity for the specified plan. If successful, you receive an HTTP response code of 201.

See HTTP response codes for other response codes.

POST /pcc/spcm/subscribers/<msisdn>/plans/<planId>boost + JSON request payload

HEADER INFO

authorisation: HTTP Basic Auth

tenant: <tenantName>

content-type: application/JSON

accept: application/JSON

By default, accept is XML. You must explicitly set accept in your header to application/JSON to receive a JSON response.

permissions: SPCM_PLAN_BOOSTER_CREATE_PERMISSION

URL parameters

There are two mandatory parameters.

Parameter Type Description

msisdn

integer

The subscriber’s MSISDN in international format.

planId

integer

The unique identifier for the subscriber plan.


JSON request payload

The following sample applies the booster with the id of 42 to the plan. See Plan definition descriptions for all possible data types.

{
    "id": "42",
    "type": "VOLUME",
    "amount": "5000",
    "cost": 475
}

Booster type descriptions

Field Type Description

id

integer

The unique identifier for the booster. This is assigned by the server upon creating a booster.

type

string

The type of booster desired by the user.

options

  • VOLUME which boosts data

  • VALIDITY which extends the plan

amount

string

The amount of data (or extension of plan).

VOLUME is in bytes, so you boost by the bytes you would like to increase. VALIDITY is in days, so you need to specify the number of days you wish to extend the plan by.

cost

integer

Specifies the cost of the booster.


HTTP response codes

Code Description

201/204

success!

If you receive a 204 code, you will not see a JSON response.

207

Multistatus response

Check out HTTP statuses for more details.
This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

booster not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.
This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example
HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example
HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

500

internal error

503

request rejected due to overload