Get a customer's plan
const url = 'https://api.poweredbyaura.com/v1/customers/CUS-204871/plan?campaign_id=cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.poweredbyaura.com/v1/customers/CUS-204871/plan?campaign_id=cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA' \ --header 'Authorization: Bearer <token>'Where one customer stands on their plan: its size, this period’s data, what keeps it and when the period ends. Use it to build your own plan screen, or use the plan card instead.
For a customer in the comparison group, status is not_offered: don’t show them the plan.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Your own ID for the customer, as you send it in actions.
Example
CUS-204871Query Parameters
Section titled “Query Parameters”The campaign whose plan to return. Required when the customer is in more than one campaign.
Example
cmp_01JA9TQ4W2D8M5X4N6B1C0VEKAResponses
Section titled “Responses”The customer’s plan.
object
The plan’s name as customers see it.
not_offered: the customer is in the comparison group. offered: the plan was offered, after its start
action or by an offer, and waits for the customer to accept. active: accepted, and this period is kept or
still open. at_risk: the warning has gone
out and this period’s action isn’t in yet. cancelled: a period ended without its action. ended: the
customer held the plan for its full length, or the campaign ended.
The number that gets the data. null until the customer accepts.
How often the plan’s data arrives, and so how long each period is.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
The period in progress. null when the plan isn’t running.
object
Which period of the plan this is, from 1.
When plan.at_risk goes out if the period isn’t kept by then.
Whether this period’s action is in.
The actions that keep this period, with their readable names for your screens.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
When the plan grows next, if a plan that grows is on.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
When the plan was offered, by its start action or by an offer.
When the customer accepted and the plan started.
When a cancelled plan can start again, in Lagos time. null when it can’t restart.
The first day the customer can change their number again.
The plan terms the customer agrees to when they accept. text already has the plan’s name, amounts and your
app’s name filled in: show it unchanged on your own plan screen, and send version as terms_version when
the customer accepts. The plan card shows the same text.
object
The terms’ version.
The terms as plain text, ready to show.
The same terms as a web page.
Examples
An active weekly plan, kept this week
{ "id": "pln_01JAC4XB7Q2W9D8M5X4N6B1C0V", "object": "plan", "campaign_id": "cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA", "customer_id": "CUS-204871", "name": "Your 6GB plan from Your Savings App", "status": "active", "phone_number": "+2348000000001", "network_id": "net_ng_a", "value": { "amount": 400000, "currency": "NGN" }, "cadence": "weekly", "monthly_gb": 6, "delivery_gb": 1.5, "current_period": { "number": 3, "starts_at": "2026-10-18T23:00:00Z", "ends_at": "2026-10-25T22:59:59Z", "warning_at": "2026-10-23T22:59:59Z", "kept": true, "actions_needed": [ { "key": "weekly_deposit", "name": "Weekly deposit" } ], "delivered_gb": 1.5 }, "this_month": { "delivered_gb": 4.5 }, "grows": null, "offered_at": "2026-10-06T09:12:00Z", "accepted_at": "2026-10-06T09:15:40Z", "ended_at": null, "end_reason": null, "can_restart_from": null, "number_change_from": "2026-10-06", "terms": { "version": "2026-10-21", "text": "Your 6GB plan from Your Savings App gives you 1.5GB of mobile data each week while you save at least ₦5,000 each week. If a week ends without a deposit, the plan stops. …", "url": "https://app.poweredbyaura.com/plan-terms/2026-10-21" }, "test": false}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
The request is malformed or a field is invalid. Fix it before retrying.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "invalid_phone_number", "message": "phone_number must be in E.164 format, such as +2348000000001.", "param": "phone_number", "retryable": false, "request_id": "req_9Qd4Hs1XvB7n" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
The API key is missing, wrong or revoked.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "invalid_api_key", "message": "The API key is missing, wrong or revoked.", "retryable": false, "request_id": "req_4Lm8Tc2VqZ7k" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Nothing with this ID exists in your account, in this mode (test or live).
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "not_found", "message": "No customer with ID 'CUS-204871' has been reported to this campaign.", "retryable": false, "request_id": "req_5Nk3Ry8BwH1c" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Too many requests. Wait for Retry-After seconds, then retry.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "rate_limited", "message": "Too many requests. Retry after 2 seconds.", "retryable": true, "request_id": "req_2Vb7Nx4KtJ9q" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Requests allowed in the current window.
Requests left in the current window.
Seconds until the current window resets.
Seconds to wait before retrying.
© 2026 PressOne Africa Limited ·poweredbyaura.com ·Privacy ·Terms