Subscriber Credits API

Credit Group Names

Before adding credit profiles you must define atleast one credit group name to be used.

Reference material for usage on Subscriber > Credits and Credit Profiles > Credit Group Names.

GET

/v1/credit/names

(subscriber)

List Credit Names.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.

Response Example

{
    "payload": [
        {
            "id": "95ca692a-9ecb-4f72-b375-8024e4314d97",
            "name": "ANYTIME DATA"
        },
        {
            "id": "802adac9-4d4b-4f0e-ab95-73d8d80b7d35",
            "name": "MONTHLY ANYTIME"
        },
        {
            "id": "76a02416-bb5d-11ee-8769-525400bd8e3a",
            "name": "Monthly Daytime"
        },
        {
            "id": "9690e530-bb5c-11ee-8769-525400bd8e3a",
            "name": "TOPUP Anytime"
        },
        {
            "id": "1d00f8f3-bb5e-11ee-8769-525400bd8e3a",
            "name": "TOPUP Daytime"
        }
    ],
    "metadata": {
        "records": 5,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/credit/name/{credit_group_name_id}

(subscriber)

Get credit name by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
credit_group_name_id	url	string	Credit Group Name Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.

Response Example

{
    "id": "9690e530-bb5c-11ee-8769-525400bd8e3a",
    "name": "TOPUP Anytime"
}

POST

/v1/credit/name

(subscriber)

Add credit name.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
name	body	string	Name of Entity.	X

Request Example

{
    "name": "TOPUP Anytime"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.

Response Example

{
    "id": "9690e530-bb5c-11ee-8769-525400bd8e3a",
    "name": "TOPUP Anytime"
}

DELETE

/v1/credit/name/{credit_group_name_id}

(subscriber)

Remove credit group name by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
credit_group_name_id	url	string	Credit Group Name Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Credit Profiles

Before adding a credit to a subscriber, you must define atleast one credit profile to be used for appylying a credit to a subscriber.

Reference material for usage on Subscriber > Credits and Credit Profiles > Credit Profiles.

GET

/v1/credit/profiles

(subscriber)

List Credit Profiles.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
credit_name	query	string	Filter by credit_name. (can suffix with wildcard )*
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name, volume_gb, credit_name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending
volume_gb	query	string	Filter by volume_gb. (can suffix with wildcard )*

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_name	body	string	Credit Name.
end_hour	body	string	End Hour.
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.
renew_metric	body	string	Renew Metric.
renew_span	body	integer	Renew Span.
start_hour	body	string	Start Hour.
volume_gb	body	integer	Volume Gb.
volume_metric	body	string	Volume Metric.
volume_span	body	integer	Volume Span.

Response Example

{
    "payload": [
        {
            "id": "7a68ba0f-0782-483b-bf39-93955b2e4852",
            "name": "123GB Monthly Anytime",
            "credit_name": "Monthly Anytime",
            "start_hour": "00:00",
            "end_hour": "23:59",
            "volume_gb": 123,
            "volume_metric": "months",
            "volume_span": 2,
            "renew_metric": "1st-of-month",
            "renew_span": 1
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/credit/profile/{credit_profile_id}

(subscriber)

View credit profile by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
credit_profile_id	url	string	Credit Profile Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_name	body	string	Credit Name.
end_hour	body	string	End Hour.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
renew_metric	body	string	Renew Metric.
renew_span	body	integer	Renew Span.
start_hour	body	string	Start Hour.
volume_gb	body	integer	Volume Gb.
volume_metric	body	string	Volume Metric.
volume_span	body	integer	Volume Span.

Response Example

{
    "id": "7a68ba0f-0782-483b-bf39-93955b2e4852",
    "name": "123GB Monthly Anytime",
    "credit_name": "Monthly Anytime",
    "start_hour": "00:00",
    "end_hour": "23:59",
    "volume_gb": 123,
    "volume_metric": "months",
    "volume_span": 2,
    "renew_metric": "1st-of-month",
    "renew_span": 1
}

POST

/v1/credit/profile

(subscriber)

Add credit profile.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
credit_name	body	string	Credit Name.	X
end_hour	body	string	End Hour.	X
name	body	string	Name of Entity.	X
renew_metric	body	string	Renew Metric.	X
renew_span	body	integer	Renew Span.	X
start_hour	body	string	Start Hour.	X
volume_gb	body	integer	Volume Gb.	X
volume_metric	body	string	Volume Metric.	X
volume_span	body	integer	Volume Span.	X

Request Example

{
    "name": "123GB Monthly Anytime",
    "credit_name": "Monthly Anytime",
    "start_hour": "00:00",
    "end_hour": "23:59",
    "volume_gb": 123,
    "volume_metric": "months",
    "volume_span": 2,
    "renew_metric": "1st-of-month",
    "renew_span": 1
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_name	body	string	Credit Name.
end_hour	body	string	End Hour.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
renew_metric	body	string	Renew Metric.
renew_span	body	integer	Renew Span.
start_hour	body	string	Start Hour.
volume_gb	body	integer	Volume Gb.
volume_metric	body	string	Volume Metric.
volume_span	body	integer	Volume Span.

Response Example

{
    "id": "7a68ba0f-0782-483b-bf39-93955b2e4852",
    "name": "123GB Monthly Anytime",
    "credit_name": "Monthly Anytime",
    "start_hour": "00:00",
    "end_hour": "23:59",
    "volume_gb": 123,
    "volume_metric": "months",
    "volume_span": 2,
    "renew_metric": "1st-of-month",
    "renew_span": 1
}

DELETE

/v1/credit/profile/{credit_profile_id}

(subscriber)

Remove credit profile by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
credit_profile_id	url	string	Credit Profile Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Subscriber Credits

Manage subscriber credits by applying new credits using a predefined credit profile or purging them.

Reference material for usage on Subscriber > Credits and Credit Profiles > Subscriber Credits.

GET

/v1/credits/{subscriber_id}

(subscriber)

List Credits for a subscriber.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Subscriber Id.	X
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (name, expire, volume_gb, volume_expire, volume_used, start_hour, end_hour, used)
sd	query	string	Sort direction. asc for Ascending or desc for Descending
volume_gb	query	integer	Filter by volume_gb.

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_profile	body	string	Credit Profile.
credit_profile_id	body	string	Credit Profile Id.
end_hour	body	string	End Hour.
expire	body	string	Expire.
id	body	string	Unique Entity ID.
left_over_gb	body	integer	Left Over Gb.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.
start_hour	body	string	Start Hour.
subscriber_id	body	string	Subscriber Id.
used	body	integer	Used.
used_bytes	body	integer	Used Bytes.
used_gb	body	integer	Used Gb.
username	body	string	Username.
volume_expire	body	string	Volume Expire.
volume_gb	body	integer	Volume Gb.

Response Example

{
    "payload": [
        {
            "id": "4ed4495c-cbe9-11ee-9127-a5b2efd1bd16",
            "credit_profile_id": "64ea15cd-e432-4a98-bcf3-511a00182945",
            "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
            "volume_gb": 123,
            "name": "TOPUP Anytime",
            "start_hour": "00:00",
            "end_hour": "23:59",
            "expire": null,
            "volume_expire": "2024-04-15T10:02:20+00:00",
            "used": 0,
            "username": "test@example.com",
            "used_bytes": 0,
            "used_gb": 0.0,
            "left_over_gb": 123.0,
            "credit_profile": "123GB TOPUP Anytime"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/credit/{subscriber_credit_id}

(subscriber)

Show subscriber credit by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_credit_id	url	string	Subscriber Credit Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_profile	body	string	Credit Profile.
credit_profile_id	body	string	Credit Profile Id.
end_hour	body	string	End Hour.
expire	body	string	Expire.
id	body	string	Unique Entity ID.
left_over_gb	body	integer	Left Over Gb.
name	body	string	Name of Entity.
start_hour	body	string	Start Hour.
subscriber_id	body	string	Subscriber Id.
used	body	integer	Used.
used_bytes	body	integer	Used Bytes.
used_gb	body	integer	Used Gb.
username	body	string	Username.
volume_expire	body	string	Volume Expire.
volume_gb	body	integer	Volume Gb.

Response Example

{
    "id": "4ed4495c-cbe9-11ee-9127-a5b2efd1bd16",
    "credit_profile_id": "64ea15cd-e432-4a98-bcf3-511a00182945",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "volume_gb": 123,
    "name": "TOPUP Daytime",
    "start_hour": "00:00",
    "end_hour": "23:59",
    "expire": null,
    "volume_expire": "2024-04-15T10:02:20+00:00",
    "used": 0,
    "username": "test7000",
    "used_bytes": 0,
    "used_gb": 0.0,
    "left_over_gb": 123.0,
    "credit_profile": "123GB TOPUP Daytime"
}

POST

/v1/credit

(subscriber)

Add credit to subscriber.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
credit_profile_id	body	string	Credit Profile Id.
subscriber_id	body	string	Subscriber Id.

Request Example

{
    "credit_profile_id": "64ea15cd-e432-4a98-bcf3-511a00182945",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
credit_profile	body	string	Credit Profile.
credit_profile_id	body	string	Credit Profile Id.
end_hour	body	string	End Hour.
expire	body	string	Expire.
id	body	string	Unique Entity ID.
left_over_gb	body	integer	Left Over Gb.
name	body	string	Name of Entity.
start_hour	body	string	Start Hour.
subscriber_id	body	string	Subscriber Id.
used	body	integer	Used.
used_bytes	body	integer	Used Bytes.
used_gb	body	integer	Used Gb.
username	body	string	Username.
volume_expire	body	string	Volume Expire.
volume_gb	body	integer	Volume Gb.

Response Example

{
    "id": "4ed4495c-cbe9-11ee-9127-a5b2efd1bd16",
    "credit_profile_id": "64ea15cd-e432-4a98-bcf3-511a00182945",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "volume_gb": 123,
    "name": "TOPUP Anytime",
    "start_hour": "00:00",
    "end_hour": "23:59",
    "expire": null,
    "volume_expire": "2024-04-15T10:02:20+00:00",
    "used": 0,
    "username": "test@example.com",
    "used_bytes": 0,
    "used_gb": 0.0,
    "left_over_gb": 123.0,
    "credit_profile": "123GB TOPUP Anytime"
}

DELETE

/v1/credit/{subscriber_credit_id}

(subscriber)

Remove subscriber credit by ID.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
subscriber_credit_id	url	string	Subscriber Credit Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Navigation

Subscriber Credits API

Credit Group Names

Credit Profiles

Subscriber Credits