{ "info": { "name": "MTN Customer Subscription Management API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "List all Subscriptions", "description": "Get a Customer's Subscriptions given the Customer's id", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": { "2": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "3": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions" ], "query": [ { "key": "subscriptionProviderId", "value": "", "required": 0, "type": "string", "description": "Subscription Provider to query" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "List of customer's subscriptions", "schema": { "customerId": { "type": "string" }, "services": { "statusCode": { "type": "string" }, "data": { "subscriptions": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subscription" }, "subscriptionProviderId": { "type": "string", "default": "null", "description": "Identifier for the provider within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "Adhoc", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date-time", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date-time", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "subscriptionPaymentSource": { "type": "string", "default": "null", "description": "Payment balance to use: Airtime, MoMo, EVDS, Loyalty" }, "sendSMSNotification": { "type": "boolean", "default": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription" }, "beneficiaryId": { "type": "string", "default": "null", "description": "Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123" }, "email": { "type": "string", "default": "null", "description": "Email associated with the Subscription" }, "auto-renew": { "type": "boolean", "default": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period" }, "_links": { "self": { "href": { "type": "string" } } } } }, "_links": { "self": { "href": { "type": "string" } } } } }, "body": "{\"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\"}}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 207, "status": "Multi-Status", "name": "Multi-Status response - Partial list of customer's subscriptions", "schema": { "customerId": { "type": "string" }, "services": { "statusCode": { "type": "string" }, "data": { "subscriptions": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subscription" }, "subscriptionProviderId": { "type": "string", "default": "null", "description": "Identifier for the provider within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "Adhoc", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date-time", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date-time", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "subscriptionPaymentSource": { "type": "string", "default": "null", "description": "Payment balance to use: Airtime, MoMo, EVDS, Loyalty" }, "sendSMSNotification": { "type": "boolean", "default": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription" }, "beneficiaryId": { "type": "string", "default": "null", "description": "Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123" }, "email": { "type": "string", "default": "null", "description": "Email associated with the Subscription" }, "auto-renew": { "type": "boolean", "default": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period" }, "_links": { "self": { "href": { "type": "string" } } } } }, "_links": { "self": { "href": { "type": "string" } } } } }, "body": "{\"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\"}}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Subscribe the customer to a new service", "description": "Provision\/add a new subscription to the customers account", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Post", "header": { "2": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "3": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "subscriptionId", "value": "", "description": "Unique identifier for the Subscription", "required": 1, "type": "string" }, { "key": "subscriptionProviderId", "value": "", "description": "Identifier for the provider within which the Subscription lives", "required": 1, "type": "string" }, { "key": "subscriptionName", "value": "", "description": "Service the customer is subscribed to", "required": 1, "type": "string" }, { "key": "subscriptionStatus", "value": "", "description": "Active, Inactive, Pending", "required": 0, "type": "string" }, { "key": "subscriptionDescription", "value": "", "description": "Description of the service the customer is subscribed to", "required": 0, "type": "string" }, { "key": "subscriptionType", "value": "Adhoc", "description": "Adhoc, Recurring", "required": 0, "type": "string" }, { "key": "subscriptionLength", "value": "", "description": "Duration of the subscription the customer is subscribed to", "required": 0, "type": "string" }, { "key": "registrationChannel", "value": "", "description": "Channel through which the customer subscribed to the service", "required": 0, "type": "string" }, { "key": "startDate", "value": "", "description": "Start date of the Subscription; full-date notation RFC 3339", "required": 0, "type": "string" }, { "key": "endDate", "value": "", "description": "End date of the Subscription; full-date notation RFC 3339", "required": 0, "type": "string" }, { "key": "subscriptionPaymentSource", "value": "Airtime", "description": "Which payment balance to use to pay: Airtime, MoMo, EVDS, Loyalty", "required": 0, "type": "string" }, { "key": "sendSMSNotification", "value": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription", "required": 0, "type": "boolean" }, { "key": "beneficiaryId", "value": "", "description": "Subscription will be added to the beneficiary, but payment deducted from the main customerId", "required": 0, "type": "string" }, { "key": "auto-renew", "value": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period", "required": 0, "type": "boolean" }, { "key": "email", "value": "", "description": "Email address associated with the Subscription", "required": 0, "type": "string" } ] } }, "response": [ { "code": 201, "status": "Created", "name": "Created", "schema": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique identifier for the Subscription" }, "subscriptionProviderId": { "type": "string", "default": "null", "description": "Identifier for the provider within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "Adhoc", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date-time", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date-time", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "subscriptionPaymentSource": { "type": "string", "default": "Airtime", "description": "Which payment balance to use to pay: Airtime, MoMo, EVDS, Loyalty" }, "sendSMSNotification": { "type": "boolean", "default": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription" }, "beneficiaryId": { "type": "string", "default": "null", "description": "Subscription will be added to the beneficiary, but payment deducted from the main customerId" }, "auto-renew": { "type": "boolean", "default": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period" }, "email": { "type": "string", "default": "null", "description": "Email address associated with the Subscription" } }, "body": "{\"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\"}", "header": { "Location": { "type": "string", "description": "Location header will include the link to the newly created subscription" }, "0": { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } } }, { "code": 202, "status": "Accepted", "name": "Accepted", "schema": { "subscriptionId": { "type": "integer", "description": "ID for the Subscription" }, "subscriptionProviderId": { "type": "integer", "description": "Identity of the subscription provider hosting the subscription" }, "statusCode": { "type": "integer", "description": "Status Code" }, "status": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "description": { "type": "string", "description": "Details of the result of the unsubscribe action" } }, "body": "{\"subscriptionId\":1,\"subscriptionProviderId\":1,\"statusCode\":1,\"status\":\"string\",\"description\":\"string\"}", "header": { "Location": { "type": "string", "description": "Location header will include the link to the status URL for the new subscription" }, "0": { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } } }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Unsubscribe All Subscriptions for a Customer", "description": "Unsubscribe All Subscriptions for a Customer", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Delete", "header": { "3": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "4": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions" ], "query": [ { "key": "subscriptionProviderId", "value": "", "required": true, "type": "string", "description": "Identity of the subscription provider hosting the subscription" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "callbackUrl", "value": "", "description": "", "required": 0, "type": "string" }, { "key": "description", "value": "", "description": "", "required": 0, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Result of the unsubscribe action", "schema": { "subscriptionId": { "type": "integer", "description": "ID for the Subscription" }, "subscriptionProviderId": { "type": "integer", "description": "Identity of the subscription provider hosting the subscription" }, "statusCode": { "type": "integer", "description": "Status Code" }, "status": { "type": "string", "default": "", "description": "Unsubscribe successful,Unsubscribe unsuccessful" }, "description": { "type": "string", "description": "Details of the result of the unsubscribe action" } }, "body": "{\"subscriptionId\":1,\"subscriptionProviderId\":1,\"statusCode\":1,\"status\":\"string\",\"description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Get Subscription details", "description": "Retrieve specific subscription details for a customer", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": { "3": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "4": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions\/{subscriptionId}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions", "{subscriptionId}" ], "query": [ { "key": "subscriptionProviderId", "value": "", "required": true, "type": "string", "description": "Identity of the subscription provider hosting the subscription" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Subscription details", "schema": { "customerId": { "type": "string" }, "services": { "statusCode": { "type": "string" }, "data": { "subscriptions": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subscription" }, "subscriptionProviderId": { "type": "string", "default": "null", "description": "Identifier for the provider within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "Adhoc", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date-time", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date-time", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "subscriptionPaymentSource": { "type": "string", "default": "null", "description": "Payment balance to use: Airtime, MoMo, EVDS, Loyalty" }, "sendSMSNotification": { "type": "boolean", "default": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription" }, "beneficiaryId": { "type": "string", "default": "null", "description": "Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123" }, "email": { "type": "string", "default": "null", "description": "Email associated with the Subscription" }, "auto-renew": { "type": "boolean", "default": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period" }, "_links": { "self": { "href": { "type": "string" } } } } }, "_links": { "self": { "href": { "type": "string" } } } } }, "body": "{\"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\"}}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Unsubscribe a specific subscription", "description": "Delete a specific subscription", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Delete", "header": { "3": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "4": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions\/{subscriptionId}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions", "{subscriptionId}" ], "query": [ { "key": "subscriptionProviderId", "value": "", "required": true, "type": "string", "description": "Identity of the subscription provider hosting the subscription" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Result of the unsubscribe action", "schema": { "subscriptionId": { "type": "integer", "description": "ID for the Subscription" }, "subscriptionProviderId": { "type": "integer", "description": "Identity of the subscription provider hosting the subscription" }, "statusCode": { "type": "integer", "description": "Status Code" }, "status": { "type": "string", "default": "", "description": "Unsubscribe successful,Unsubscribe unsuccessful" }, "description": { "type": "string", "description": "Details of the result of the unsubscribe action" } }, "body": "{\"subscriptionId\":1,\"subscriptionProviderId\":1,\"statusCode\":1,\"status\":\"string\",\"description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Get provisioning status of a recently added Subscription", "description": "For certain provisioning requests to add a new subscription, the response will be asynchronous, with a status of PENDING. Use this query to poll the final status of the provisioning, using the transactionID that was used for the original provisioning request.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": { "4": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "5": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions\/{subscriptionId}\/status\/{statusId}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions", "{subscriptionId}", "status", "{statusId}" ], "query": [ { "key": "subscriptionProviderId", "value": "", "required": true, "type": "string", "description": "Identity of the subscription provider hosting the subscription" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Subscription details", "schema": { "customerId": { "type": "string" }, "services": { "statusCode": { "type": "string" }, "data": { "subscriptions": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subscription" }, "subscriptionProviderId": { "type": "string", "default": "null", "description": "Identifier for the provider within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive,Pending" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "Adhoc", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date-time", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date-time", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "subscriptionPaymentSource": { "type": "string", "default": "null", "description": "Payment balance to use: Airtime, MoMo, EVDS, Loyalty" }, "sendSMSNotification": { "type": "boolean", "default": "true", "description": "Should an SMS be sent to the subscriber to inform them of the subscription" }, "beneficiaryId": { "type": "string", "default": "null", "description": "Subscription will be added to the beneficiary msisdn, but payment deducted from the main customerId. format will be E.123" }, "email": { "type": "string", "default": "null", "description": "Email associated with the Subscription" }, "auto-renew": { "type": "boolean", "default": "false", "description": "Recurring subscription to auto-renew at the end of the expiry period" }, "_links": { "self": { "href": { "type": "string" } } } } }, "_links": { "self": { "href": { "type": "string" } } } } }, "body": "{\"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\"}}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Retrieve subscription providers", "description": "Show the list of all Subscription providers that a customer may have subscriptions with", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": { "1": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests" }, "2": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/subscriptions-providers", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "customers", "{customerId}", "subscriptions-providers" ] } }, "response": [ { "code": 200, "status": "OK", "name": "Subscription details", "schema": { "customerId": { "type": "string" }, "services": { "subscriptionProviderName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionProviderDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "_links": { "self": { "href": { "type": "string" } } } } }, "body": "{\"customerId\":\"string\",\"services\":{\"subscriptionProviderName\":\"string\",\"subscriptionProviderDescription\":\"string\",\"_links\":{\"self\":{\"href\":\"string\"}}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "HTTP Status code" }, "error": { "type": "string", "description": "Status description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Callback service that MTN API will POST to with the result of the DELETE all subscriptions", "description": "The result of the asynchronous DELETE for all a customers subscriptions will be POSTed to the callback URL that the developer must host. If there were multiple subscriptions, each result will be posted individually as it completes.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/callback\/delete-all-subscriptions", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v2", "callback", "delete-all-subscriptions" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "subscriptionId", "value": "", "description": "ID for the Subscription", "required": 0, "type": "integer" }, { "key": "subscriptionProviderId", "value": "", "description": "Identity of the subscription provider hosting the subscription", "required": 0, "type": "integer" }, { "key": "statusCode", "value": "", "description": "Status Code", "required": 1, "type": "integer" }, { "key": "status", "value": "", "description": "Unsubscribe successful, Unsubscribe unsuccessful", "required": 0, "type": "string" }, { "key": "description", "value": "", "description": "Details of the result of the unsubscribe action", "required": 1, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "OK", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }