Offer a plan to a customer
const url = 'https://api.poweredbyaura.com/v1/offers';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"reference":"off-552018","campaign_id":"cmp_01JAE3M8Q4W7T2K9R5F1H6P3NB","customer_id":"CUS-204871","phone_number":"+2348000000001","source":"october_offer"}'};
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/offers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reference": "off-552018", "campaign_id": "cmp_01JAE3M8Q4W7T2K9R5F1H6P3NB", "customer_id": "CUS-204871", "phone_number": "+2348000000001", "source": "october_offer" }'For campaigns that start plans by offer. Offers the plan to one customer, with no action needed first. The customer accepts it on the plan card, or on your own screen, and the plan starts with the first week’s data.
The first time you report a customer, Aura places them at random in the offer group or the comparison group.
Don’t show the plan to customers in the comparison group: group is comparison and the plan is
not_offered. Keep sending their actions, so the results can show what the plan caused.
An offer stays open until the customer accepts or the campaign ends. reference makes the request safe to
retry, exactly as for actions.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Your unique ID for this offer. Letters, numbers, -, _, . and :, up to 64 characters.
Your own ID for the customer. Up to 64 characters. Never send names.
The customer’s number on your records, in E.164 format. When they accept, they can choose another of their numbers for the data.
Optional. Where the offer went out, such as a campaign in your app, for the cost per new customer by source.
Up to 20 keys of your own, returned on the offer and in webhooks.
object
Examples
{ "reference": "off-552018", "campaign_id": "cmp_01JAE3M8Q4W7T2K9R5F1H6P3NB", "customer_id": "CUS-204871", "phone_number": "+2348000000001", "source": "october_offer"}Responses
Section titled “Responses”An offer with this reference and the same body already exists. It is returned as it is now.
object
The customer’s group. Don’t show the plan to customers in the comparison group.
object
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.
object
object
Examples
A plan offered, waiting for the customer to accept
{ "id": "off_01JAE3N2T7K4W9R1F6H3P8QX5L", "object": "offer", "reference": "off-552018", "campaign_id": "cmp_01JAE3M8Q4W7T2K9R5F1H6P3NB", "customer_id": "CUS-204871", "phone_number": "+2348000000001", "source": "october_offer", "group": "offer", "plan": { "id": "pln_01JAE3N2T7K4W9R1F6H3P8QX5M", "object": "plan", "status": "offered", "current_period": null }, "created_at": "2026-10-20T09:30:00Z", "test": false, "metadata": {}}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Always true on a replayed response.
The offer was made, or the customer was placed in the comparison group.
object
The customer’s group. Don’t show the plan to customers in the comparison group.
object
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.
object
object
Examples
A plan offered, waiting for the customer to accept
{ "id": "off_01JAE3N2T7K4W9R1F6H3P8QX5L", "object": "offer", "reference": "off-552018", "campaign_id": "cmp_01JAE3M8Q4W7T2K9R5F1H6P3NB", "customer_id": "CUS-204871", "phone_number": "+2348000000001", "source": "october_offer", "group": "offer", "plan": { "id": "pln_01JAE3N2T7K4W9R1F6H3P8QX5M", "object": "plan", "status": "offered", "current_period": null }, "created_at": "2026-10-20T09:30:00Z", "test": false, "metadata": {}}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.
An offer with this reference exists with a different body. 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
Example
{ "error": { "code": "invalid_request" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
The offer can’t be made: the campaign starts plans after an action, isn’t live for this key, or the customer already has an offer or a plan in it. 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": "campaign_starts_with_action", "message": "This campaign starts plans after an action. Report the action instead of sending an offer.", "param": "campaign_id", "retryable": false, "request_id": "req_7Jd2Rk5NwB9t" }}{ "error": { "code": "already_offered", "message": "Customer 'CUS-204871' already has an offer in this campaign.", "param": "customer_id", "retryable": false, "request_id": "req_3Qm8Wc1HsV6p", "details": { "plan_id": "pln_01JAE3N2T7K4W9R1F6H3P8QX5M" } }}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.
Something went wrong on Aura’s side. Retry with the same reference; it is safe.
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": "internal_error", "message": "Something went wrong on our side. Retry with the same reference.", "retryable": true, "request_id": "req_6Gt1Mz5RcW3p" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
© 2026 PressOne Africa Limited ·poweredbyaura.com ·Privacy ·Terms