Catalogue
List plans
A provider's priced bundles and packages. amount is what you pay for the plan, before your commission. The id here is the plan_id an order needs.
Plans are synced from the vendors and do change during the day, so read them when you need them rather than caching them overnight.
Shares the budget your orders do not reserve. Works with a live or test key.
curl 'https://stagingapi.getelectric.ng/api/v2/reseller/catalogue/providers/3/plans' \
-H 'Authorization: Bearer <your-test-key>'// The provider's plans. An empty list means the provider sells nothing by plan today, not that the provider is unknown.Authorization
AuthorizationstringheaderrequiredYour reseller API key, as Bearer <key>.
Path parameters
providerintegerpathrequiredA provider id from listProviders.
1 or more
Response 200
The provider's plans. An empty list means the provider sells nothing by plan today, not that the provider is unknown.
successbooleanrequiredstatusstringrequiredOne of success, failed
codeintegerrequiredThe HTTP status, repeated in the body. It is not an error code: this API has none, so the message text is the only thing distinguishing one refusal from another, and message text is not a stable contract.
messagestringrequireddataobjectrequiredShow child attributes
provider_idintegerrequiredplansarray of objectrequiredShow child attributes
idintegerrequiredThe plan_id an order needs.
codestringrequirednamestringrequireddescriptionstringamountnumberrequiredWhat this plan costs you, in naira, before commission.
validity_daysintegernullablerequiredNull when the vendor did not say and the name did not imply one.
bucketstringA rough size band, for grouping plans in a list.
sort_orderintegerrequiredOther responses
- 400
- That provider reference is not a positive whole number.
- 401
- No key, a malformed Authorization header, or a key that no longer exists.
- 403
- The key is real but may not do this. Three separate causes, and only the message tells them apart: the token cannot use the reseller API at all, the calling address is not on your allowlist, or the key carries both test and live access and must be reissued for one mode.
- 429
- You have too many requests open at once. This is a concurrency cap, not a rate limit: wait for your open requests to finish rather than backing off a fixed time. Retry-After is 1.
- 503
- We could not load the catalogue. Safe to retry.