Download
Download Postman collection Download SwaggerAvailable endpoints
GET v2/customers/{customerId}/subscriptions
200OK
customerId string
services
statusCode string
data
subscriptions
subscriptionId string
Unique system identifier for the SubscriptionsubscriptionProviderId string
Identifier for the provider within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,Inactive,PendingsubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339subscriptionPaymentSource string
Payment balance to use: Airtime, MoMo, EVDS, LoyaltysendSMSNotification boolean
Should an SMS be sent to the subscriber to inform them of the subscriptionbeneficiaryId string
Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123email string
Email associated with the Subscriptionauto-renew boolean
Recurring subscription to auto-renew at the end of the expiry period_links
self
href string
_links
self
href string
{
"customerId": "string",
"services": {
"statusCode": "string",
"data": {
"subscriptions": {
"subscriptionId": "string",
"subscriptionProviderId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "Adhoc",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"subscriptionPaymentSource": "string",
"sendSMSNotification": "true",
"beneficiaryId": "string",
"email": "string",
"auto-renew": "false",
"_links": {
"self": {
"href": "string"
}
}
}
},
"_links": {
"self": {
"href": "string"
}
}
}
}
207Multi-Status
customerId string
services
statusCode string
data
subscriptions
subscriptionId string
Unique system identifier for the SubscriptionsubscriptionProviderId string
Identifier for the provider within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,Inactive,PendingsubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339subscriptionPaymentSource string
Payment balance to use: Airtime, MoMo, EVDS, LoyaltysendSMSNotification boolean
Should an SMS be sent to the subscriber to inform them of the subscriptionbeneficiaryId string
Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123email string
Email associated with the Subscriptionauto-renew boolean
Recurring subscription to auto-renew at the end of the expiry period_links
self
href string
_links
self
href string
{
"customerId": "string",
"services": {
"statusCode": "string",
"data": {
"subscriptions": {
"subscriptionId": "string",
"subscriptionProviderId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "Adhoc",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"subscriptionPaymentSource": "string",
"sendSMSNotification": "true",
"beneficiaryId": "string",
"email": "string",
"auto-renew": "false",
"_links": {
"self": {
"href": "string"
}
}
}
},
"_links": {
"self": {
"href": "string"
}
}
}
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
POST v2/customers/{customerId}/subscriptions
201Created
subscriptionId string
Unique identifier for the SubscriptionsubscriptionProviderId string
Identifier for the provider within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,Inactive,PendingsubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339subscriptionPaymentSource string
Which payment balance to use to pay: Airtime, MoMo, EVDS, LoyaltysendSMSNotification boolean
Should an SMS be sent to the subscriber to inform them of the subscriptionbeneficiaryId string
Subscription will be added to the beneficiary, but payment deducted from the main customerIdauto-renew boolean
Recurring subscription to auto-renew at the end of the expiry periodemail string
Email address associated with the Subscription{
"subscriptionId": "string",
"subscriptionProviderId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "Adhoc",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"subscriptionPaymentSource": "Airtime",
"sendSMSNotification": "true",
"beneficiaryId": "string",
"auto-renew": "false",
"email": "string"
}
202Accepted
subscriptionId integer
ID for the SubscriptionsubscriptionProviderId integer
Identity of the subscription provider hosting the subscriptionstatusCode integer
Status Codestatus string
Active,Inactive,Pendingdescription string
Details of the result of the unsubscribe action{
"subscriptionId": 1,
"subscriptionProviderId": 1,
"statusCode": 1,
"status": "string",
"description": "string"
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
DELETE v2/customers/{customerId}/subscriptions
200OK
subscriptionId integer
ID for the SubscriptionsubscriptionProviderId integer
Identity of the subscription provider hosting the subscriptionstatusCode integer
Status Codestatus string
Unsubscribe successful,Unsubscribe unsuccessfuldescription string
Details of the result of the unsubscribe action{
"subscriptionId": 1,
"subscriptionProviderId": 1,
"statusCode": 1,
"status": "string",
"description": "string"
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
GET v2/customers/{customerId}/subscriptions/{subscriptionId}
200OK
customerId string
services
statusCode string
data
subscriptions
subscriptionId string
Unique system identifier for the SubscriptionsubscriptionProviderId string
Identifier for the provider within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,Inactive,PendingsubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339subscriptionPaymentSource string
Payment balance to use: Airtime, MoMo, EVDS, LoyaltysendSMSNotification boolean
Should an SMS be sent to the subscriber to inform them of the subscriptionbeneficiaryId string
Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123email string
Email associated with the Subscriptionauto-renew boolean
Recurring subscription to auto-renew at the end of the expiry period_links
self
href string
_links
self
href string
{
"customerId": "string",
"services": {
"statusCode": "string",
"data": {
"subscriptions": {
"subscriptionId": "string",
"subscriptionProviderId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "Adhoc",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"subscriptionPaymentSource": "string",
"sendSMSNotification": "true",
"beneficiaryId": "string",
"email": "string",
"auto-renew": "false",
"_links": {
"self": {
"href": "string"
}
}
}
},
"_links": {
"self": {
"href": "string"
}
}
}
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
DELETE v2/customers/{customerId}/subscriptions/{subscriptionId}
200OK
subscriptionId integer
ID for the SubscriptionsubscriptionProviderId integer
Identity of the subscription provider hosting the subscriptionstatusCode integer
Status Codestatus string
Unsubscribe successful,Unsubscribe unsuccessfuldescription string
Details of the result of the unsubscribe action{
"subscriptionId": 1,
"subscriptionProviderId": 1,
"statusCode": 1,
"status": "string",
"description": "string"
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
GET v2/customers/{customerId}/subscriptions/{subscriptionId}/status/{statusId}
200OK
customerId string
services
statusCode string
data
subscriptions
subscriptionId string
Unique system identifier for the SubscriptionsubscriptionProviderId string
Identifier for the provider within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,Inactive,PendingsubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339subscriptionPaymentSource string
Payment balance to use: Airtime, MoMo, EVDS, LoyaltysendSMSNotification boolean
Should an SMS be sent to the subscriber to inform them of the subscriptionbeneficiaryId string
Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123email string
Email associated with the Subscriptionauto-renew boolean
Recurring subscription to auto-renew at the end of the expiry period_links
self
href string
_links
self
href string
{
"customerId": "string",
"services": {
"statusCode": "string",
"data": {
"subscriptions": {
"subscriptionId": "string",
"subscriptionProviderId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "Adhoc",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"subscriptionPaymentSource": "string",
"sendSMSNotification": "true",
"beneficiaryId": "string",
"email": "string",
"auto-renew": "false",
"_links": {
"self": {
"href": "string"
}
}
}
},
"_links": {
"self": {
"href": "string"
}
}
}
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
GET v2/customers/{customerId}/subscriptions-providers
200OK
customerId string
services
subscriptionProviderName string
Service the customer is subscribed tosubscriptionProviderDescription string
Description of the service the customer is subscribed to_links
self
href string
{
"customerId": "string",
"services": {
"subscriptionProviderName": "string",
"subscriptionProviderDescription": "string",
"_links": {
"self": {
"href": "string"
}
}
}
}
400Bad Request
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
401Unauthorized
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
403Forbidden
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
404Not Found
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
405Method Not Allowed
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
500Internal Server Error
timestamp string
Error response codestatus string
HTTP Status codeerror string
Status descriptionmessage string
More error details and corrective measurespath string
the path that caused the error{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string"
}
POST v2/callback/delete-all-subscriptions