Subscriptions v1

AVAILABLE IN

Download

Download Postman collection Download Swagger

Available endpoints

GET api/customers/{id}/subscriptions

Description

Get a Customer's Subscriptions given the Customer's id

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

200OK

systems

systemId string

status string

statusCode string

message string

subscriptionList

subscriptionId string

Unique system identifier for the Subsription

systemId string

Identifier for the system within which the Subscription lives

subscriptionName string

Service the customer is subscribed to

subscriptionStatus string

Active,Inactive

subscriptionDescription string

Description of the service the customer is subscribed to

subscriptionType string

Adhoc,Recurring

subscriptionLength string

Duration of the subscription the customer is subscribed to

registrationChannel string

Channel through which the customer subscribed to the service

startDate string

Start date of the Subscription; full-date notation RFC 3339

endDate string

End date of the Subscription; full-date notation RFC 3339

email string

Email associated with the subcription

{
    "systems": [],
    "subscriptionList": []
}

206Partial Content

systems

systemId string

status string

statusCode string

message string

subscriptionList

subscriptionId string

Unique system identifier for the Subsription

systemId string

Identifier for the system within which the Subscription lives

subscriptionName string

Service the customer is subscribed to

subscriptionStatus string

Active,Inactive

subscriptionDescription string

Description of the service the customer is subscribed to

subscriptionType string

Adhoc,Recurring

subscriptionLength string

Duration of the subscription the customer is subscribed to

registrationChannel string

Channel through which the customer subscribed to the service

startDate string

Start date of the Subscription; full-date notation RFC 3339

endDate string

End date of the Subscription; full-date notation RFC 3339

email string

Email associated with the subcription

{
    "systems": [],
    "subscriptionList": []
}

400Bad Request

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

403Forbidden

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

404Not Found

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

405Method Not Allowed

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

500Internal Server Error

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

GET api/customers/{id}/subscriptions/{subscriptionId}

Description

Retrieve specific subscription details for a customer

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

systemId string required

Identify the system hosting the subscription

200OK

subscriptionId string

Unique system identifier for the Subsription

systemId string

Identifier for the system within which the Subscription lives

subscriptionName string

Service the customer is subscribed to

subscriptionStatus string

Active,Inactive

subscriptionDescription string

Description of the service the customer is subscribed to

subscriptionType string

Adhoc,Recurring

subscriptionLength string

Duration of the subscription the customer is subscribed to

registrationChannel string

Channel through which the customer subscribed to the service

startDate string

Start date of the Subscription; full-date notation RFC 3339

endDate string

End date of the Subscription; full-date notation RFC 3339

email string

Email associated with the subcription

{
    "subscriptionId": [],
    "systemId": [],
    "subscriptionName": [],
    "subscriptionStatus": [],
    "subscriptionDescription": [],
    "subscriptionType": [],
    "subscriptionLength": [],
    "registrationChannel": [],
    "startDate": [],
    "endDate": [],
    "email": []
}

400Bad Request

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

403Forbidden

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

404Not Found

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

405Method Not Allowed

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

500Internal Server Error

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

DELETE api/customers/{id}/subscriptions/{subscriptionId}

Description

Delete a specific subscription

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

systemId string required

Identify the system hosting the subscription

200OK

status string

Unsubscribe successful,Unsubscribe unsucccessful

description string

Details on result of the unsubscribe action

{
    "status": [],
    "description": []
}

400Bad Request

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

403Forbidden

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

404Not Found

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

405Method Not Allowed

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

500Internal Server Error

responseCode string

Error response code

reason string

Text explaining the reason for the error

message string

More error details and corrective measures

{
    "responseCode": [],
    "reason": [],
    "message": []
}

Check out some of our other products.

MTN

For Consent validation

View

MTN

The Customer Survey API facilitates product survey with a MTN customer.

View

MTN

View the product

View