Get My Eligible Packages

This API is used to retrieve a list of all eligible packages (‘Buy Package’) granted by the parent customer. If the customer has been tagged by the parent customer as allowed for self-service, they may receive a list of all eligible packages defined by the parent customer, provided that such packages exist.

NOTE: Multiple packages can be defined as eligible to a sub account, yet currently, only one package can be attached to a subscriber in a given time<table>

Method	Path
GET	api/v2/customer/{id}/package/my-eligible-packages

Eligibility

The requestor is eligible to request information on packages assigned to them by their parent customer if their account has been tagged as allowed for self-service.

NOTE: A package with the ‘ALL’ keyword is also included in the list of eligible packages.

API Request

Request Structure

Not applicable

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure detailed description.
content	Object	O	Array of main response body object. Displayed when an API call is successful. For a failure, it will be empty.
pageable	Object	O	Paging information object. Displayed when an API call is successful. For a failure, it will be empty.

Content

Parameter	Type	M/O/CM	Description
id	UUID	M	Package ID
name	String	M	Package name
description	String	O	Package description
nestedOffers	UUID	M	Array of offer IDs. At least one offer will be presented. The order of offer UUIDs in the array represents offer priority within the package.

pageable

Parameter	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible:

Code	Message
GLOBAL_1001	Service unavailable. Please try again
CUSTOMER_1002	Customer does not exist
CUSTOMER_1006	Failed to retrieve customer details

Examples

Request Body

Not applicable

Response Body Success ACK

Response Body Failure NAK