Skip to main content

List plans

GET 
/api/v1/plans

Lists everything your account can sell, with the price you pay (in kobo).

Every row says which family it belongs to (service), which endpoint buys it (buyEndpoint), and which field that endpoint expects for the recipient (identifierField - phone for data, accountNumber for broadband). Read those and you never need to guess where a row goes.

Pass ?service=data or ?service=broadband to narrow it to one family. If none of your services are enabled the response is 403 service.not_enabled - never an empty list.

Request​

Responses​

The plans available to you.