Accept a plan from your own screens
const url = 'https://api.poweredbyaura.com/v1/customers/CUS-204871/plan/accept';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"campaign_id":"cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA","phone_number":"+2348000000001","terms_version":"2026-10-21","accepted_at":"2026-10-20T09:41:12+01:00"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.poweredbyaura.com/v1/customers/CUS-204871/plan/accept \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "campaign_id": "cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA", "phone_number": "+2348000000001", "terms_version": "2026-10-21", "accepted_at": "2026-10-20T09:41:12+01:00" }'For businesses that build their own plan screen instead of using the plan card. Records that the customer accepted the plan and its terms, which version of the terms you showed them, and which number gets the data. The plan starts, Aura checks the number’s network, and the first week’s data is delivered. Accepting counts as keeping the week it happens in, so the plan’s action is first needed the following week.
Before the customer accepts, show them the plan’s terms.text, unchanged, and send its terms.version as
terms_version. A version that isn’t the current one is refused with 400 invalid_request.
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-204871Request Bodyrequired
Section titled “Request Bodyrequired”object
The number the customer chose for the data, in E.164 format.
The terms.version of the plan terms you showed the customer. It must be the current version.
Examples
{ "campaign_id": "cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA", "phone_number": "+2348000000001", "terms_version": "2026-10-21", "accepted_at": "2026-10-20T09:41:12+01:00"}Responses
Section titled “Responses”The customer accepted. The plan is returned with status active, and its first data is on the way.
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, a field is invalid, or terms_version isn’t the current version of the plan’s terms. Nothing changed.
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_request", "message": "terms_version is not the current version. Show the plan's current terms and send terms.version.", "param": "terms_version", "retryable": false, "request_id": "req_5Xq2Jd8RmT4w" }}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.
The request is well formed but can’t be done in the plan’s current state. Nothing changed.
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": "plan_not_offered", "message": "This customer is in the comparison group and isn't offered the plan.", "retryable": false, "request_id": "req_1Hc6Wd9PsF4m" }}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