SPS - Subscription Profile Management
Documentation Powered by Redocly

SPS - Subscription Profile Management (v5)

Download OpenAPI specification:Download

The "Subscription Profile Management" provides the ability to update subscription bill cycle and start date.

Operations

Provides the ability to perform update bill cycle frequency and start date

This API provides the ability to perform update bill cycle frequency and starting day. Cycle dates can be any number from 1-28.

Preconditions

  • Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id
  • Check the current bill frequency and start date of the subscription

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand
header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) [ 1 .. 12 ] characters ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Subscription Bill Cycle Update.

gpsi
required
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN of the active subscription

billCycleFrequency
required
string
Default: "MONTHLY"
Value: "MONTHLY"

Bill Cycle Frequency for the subscription

billCycleStartDay
required
number [ 1 .. 28 ]
Default: 1

Bill Start Day or Offset Day

Responses

Request samples

Content type
application/json
{
  • "gpsi": "19459986891",
  • "billCycleFrequency": "MONTHLY",
  • "billCycleStartDay": 1
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Provides the ability to query subscription details

This API provides the ability to get the details for a given Subscription. This will include the wholesale plan that the subscriber is billed under, the features on the subscription, and any optional characteristics. It will also show any resource ids assigned to the subscripiton, such as SIM, device, and phone number.

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

  • Get Subscription Details using GPSI: /subscriptionDetails?gpsi=GPSI
  • Get Subscription Details using ICCID: /subscriptionDetails?iccid=ICCID
  • Get Subscription Details using SubscriberId: /subscriptionDetails?subscriberId=SUBSCRIBERID

query Parameters
gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$
Example: gpsi=2812368903

GPSI/MSISDN

iccid
string (ICCID) [ 19 .. 20 ] characters ^[0-9]{19,20}$
Example: iccid=11986621644523024501

ICCID or SIM Number

subscriberId
string (subscriberId) [ 1 .. 36 ] characters ^.*$
Example: subscriberId=SUB9033192563

Identifier of Subscriber

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) [ 1 .. 12 ] characters ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "wholesaleCustomerId": "100000108464",
  • "subscriberId": "SUB9033192563",
  • "subscriptions": [
    ]
}