Skip to content

plan.at_risk

POST

Sent at the warning time before a period ends (48 hours before a weekly or monthly period and 6 hours before a daily one, unless you changed it) for each customer who hasn’t done this period’s action yet. Tell them in your app that the plan cancels unless they act before the period ends.

Aura-Event-Id
required
string

The event’s unique ID. The same event delivered twice has the same ID.

Example

evt_01JAC7T2Q4N8M3B6H6K8P1D5QS
Aura-Event-Type
required
string

Example

reward.delivered
Aura-Timestamp
required
string

When this delivery attempt was signed, in Unix seconds.

Example

1792489320
Aura-Signature
required
string

v1= followed by the lowercase hex HMAC-SHA256 of {Aura-Timestamp}.{raw body}, keyed with your webhook secret. During a secret rotation the header carries two signatures separated by a comma.

Example

v1=8c3e0f2b9e8a41b3c6d0e9f2a7b4c1d8e3f6a9b2c5d8e1f4a7b0c3d6e9f2a5b8
Media typeapplication/json
object
id
required

Same as the Aura-Event-Id header.

string
object
required
string
Allowed value: event
type
required
string
created_at
required
string format: date-time
test
required

true for events from test actions and for test events sent from the dashboard.

boolean
type
required
string
Allowed values: plan.started plan.at_risk plan.cancelled plan.resized plan.renewed
data
required
object
object
required
object
id
required
string
object
required
string
Allowed value: plan
campaign_id
required
string
customer_id
required
string
name
required

The plan’s name as customers see it.

string
status
required

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.

string
Allowed values: not_offered offered active at_risk cancelled ended
phone_number
required

The number that gets the data. null until the customer accepts.

string | null
network_id
required
string | null
value
required
One of:
object
amount
required

Amount in the currency’s minor unit (kobo for NGN).

integer
currency
required

ISO 4217 currency code.

string
/^[A-Z]{3}$/
cadence
required

How often the plan’s data arrives, and so how long each period is.

string
Allowed values: daily weekly monthly
monthly_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
delivery_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
current_period
required

The period in progress. null when the plan isn’t running.

object
number
required

Which period of the plan this is, from 1.

integer
starts_at
required
string format: date-time
ends_at
required
string format: date-time
warning_at
required

When plan.at_risk goes out if the period isn’t kept by then.

string format: date-time
kept
required

Whether this period’s action is in.

boolean
actions_needed
required

The actions that keep this period, with their readable names for your screens.

Array<object>
object
key
required
string
name
required
string
delivered_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
this_month
required
object
delivered_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
grows
required

When the plan grows next, if a plan that grows is on.

object
after_period
required
integer
delivery_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
offered_at
required

When the plan was offered, by its start action or by an offer.

string | null format: date-time
accepted_at
required

When the customer accepted and the plan started.

string | null format: date-time
ended_at
required
string | null format: date-time
end_reason
required
string | null
Allowed values: missed_period held_full_length campaign_ended
can_restart_from
required

When a cancelled plan can start again, in Lagos time. null when it can’t restart.

string | null format: date
number_change_from
required

The first day the customer can change their number again.

string | null format: date
terms
required

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
version
required

The terms’ version.

string
text
required

The terms as plain text, ready to show.

string
url
required

The same terms as a web page.

string format: uri
test
required
boolean
previous

On plan.resized, the size before.

object
delivery_gb

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
monthly_gb

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
recap

On plan.renewed, the month just ended.

object
delivered_gb

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
periods_kept
integer

Examples

ExampleatRisk

plan.at_risk, 48 hours before the week ends

{
"id": "evt_01JAD9K3W7N2Q5T8R1F4H6P3MX",
"object": "event",
"type": "plan.at_risk",
"created_at": "2026-10-23T23:00:04Z",
"test": false,
"data": {
"object": {
"id": "pln_01JAC4XB7Q2W9D8M5X4N6B1C0V",
"object": "plan",
"campaign_id": "cmp_01JA9TQ4W2D8M5X4N6B1C0VEKA",
"customer_id": "CUS-204871",
"name": "Your 6GB plan from Your Savings App",
"status": "at_risk",
"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": false,
"actions_needed": [
{
"key": "weekly_deposit",
"name": "Weekly deposit"
}
],
"delivered_gb": 0
},
"this_month": {
"delivered_gb": 3
},
"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
}
}
}

Return any 2xx status within 10 seconds to acknowledge the event.