API reference
Events
The record of everything that happened in an app, and every event type.
Read the events that happened in your app, like a paid invoice, to keep your records in step with Abuna. Abuna records every event, and also sends it to your webhook URL if you set one.
The event object
An event has the same shape here and in a webhook body. A webhook for the event carries the same id.
Attributes
idstringUnique identifier for the event. Event IDs sort in the order the events happened. See Event order.typestringThe event's type.environmentstringtestorlive.created_attimestampWhen the event happened, in Unix seconds.dataobjectThe event's data. Its fields depend on the type.
{
"created_at": 1794780106,
"data": {
"amount": 5000,
"coupon_id": null,
"credit": 0,
"currency": "XAF",
"discount": 0,
"invoice_id": "OG3ZsOC7",
"invoice_number": "ACME-000001",
"kind": "period",
"metadata": {
"user_id": "42"
},
"paid_at": 1794780106,
"payment": {
"amount": 5000,
"app_id": "qhf83tDc",
"created_at": 1794780106,
"currency": "XAF",
"driver": "sandbox",
"exchange_margin_bps": null,
"exchange_rate": null,
"exchange_rate_at": null,
"fee": 100,
"id": "tGfwt5dd",
"marked_by_api_key_id": null,
"marked_by_user_id": null,
"message": null,
"method_label": "Successful payment (test)",
"net": null,
"note": null,
"original_amount": 5000,
"original_currency": "XAF",
"period_id": "0kYPFwxJ",
"provider": "test",
"provider_reference": "test_ff6aaf0182bd3f1148bd",
"session_id": null,
"status": "succeeded"
},
"period_end": 1797372106,
"period_id": "0kYPFwxJ",
"period_start": 1794780106,
"promotion_code_id": null,
"subscription": {
"activated_at": 1794780106,
"app_id": "qhf83tDc",
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"created_at": 1794780106,
"current_period_end": 1797372106,
"current_period_start": 1794780106,
"customer_id": "GzeUZeSV",
"discount": null,
"ended_reason": null,
"id": "wTiODxvH",
"manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
"metadata": {
"user_id": "42"
},
"price_id": "IaFQHLTL",
"starts_at": 1794780106,
"status": "active",
"trial_ends_at": null
},
"subscription_id": "wTiODxvH"
},
"environment": "test",
"id": "01M7GKP458FZEMMQQ7VM7J4QK4",
"type": "invoice.paid"
}List events
GET/v1/apps/{appID}/events
Lists the app's events, newest first, one page at a time. Each page continues with older events. See Lists and filters.
Query parameters
typestringOnly events of this type, likeinvoice.paid.limitintegerHow many events to return, from 1 to 100. Defaults to 50.cursorstringThenext_cursorfrom the previous page. Send the same filters with it.
Response attributes
itemsarrayThe page's events, newest first. Empty when nothing matches.next_cursorstringnullablePass it as cursor to get the next, older page. It is null on the last page. Treat it as opaque.
Returns 200. A limit outside 1 to 100 returns 422 with code invalid and an errors item for limit.
curl "https://api.abuna.app/v1/apps/8ddhXCDW/events?type=invoice.paid" \
-H "Authorization: Bearer sk_test_..."{
"items": [
{
"created_at": 1794780106,
"data": {
"amount": 5000,
"coupon_id": null,
"credit": 0,
"currency": "XAF",
"discount": 0,
"invoice_id": "OG3ZsOC7",
"invoice_number": "ACME-000001",
"kind": "period",
"metadata": {
"user_id": "42"
},
"paid_at": 1794780106,
"payment": {
"amount": 5000,
"app_id": "qhf83tDc",
"created_at": 1794780106,
"currency": "XAF",
"driver": "sandbox",
"exchange_margin_bps": null,
"exchange_rate": null,
"exchange_rate_at": null,
"fee": 100,
"id": "tGfwt5dd",
"marked_by_api_key_id": null,
"marked_by_user_id": null,
"message": null,
"method_label": "Successful payment (test)",
"net": null,
"note": null,
"original_amount": 5000,
"original_currency": "XAF",
"period_id": "0kYPFwxJ",
"provider": "test",
"provider_reference": "test_ff6aaf0182bd3f1148bd",
"session_id": null,
"status": "succeeded"
},
"period_end": 1797372106,
"period_id": "0kYPFwxJ",
"period_start": 1794780106,
"promotion_code_id": null,
"subscription": {
"activated_at": 1794780106,
"app_id": "qhf83tDc",
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"created_at": 1794780106,
"current_period_end": 1797372106,
"current_period_start": 1794780106,
"customer_id": "GzeUZeSV",
"discount": null,
"ended_reason": null,
"id": "wTiODxvH",
"manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
"metadata": {
"user_id": "42"
},
"price_id": "IaFQHLTL",
"starts_at": 1794780106,
"status": "active",
"trial_ends_at": null
},
"subscription_id": "wTiODxvH"
},
"environment": "test",
"id": "01M7GKP458FZEMMQQ7VM7J4QK4",
"type": "invoice.paid"
}
],
"next_cursor": "MDFKOVpROEUxRjJHM0g0SjVLNk03TjhQOVE"
}Retrieve an event
GET/v1/apps/{appID}/events/{id}
Retrieves one event, in the same shape as its webhook body. Use it to fetch an event again by the id a webhook gave you.
Returns the event. If the app has no event with that ID, returns 404 with code not_found.
curl https://api.abuna.app/v1/apps/8ddhXCDW/events/01M7GKP458FZEMMQQ7VM7J4QK4 \
-H "Authorization: Bearer sk_test_..."{
"created_at": 1794780106,
"data": {
"amount": 5000,
"coupon_id": null,
"credit": 0,
"currency": "XAF",
"discount": 0,
"invoice_id": "OG3ZsOC7",
"invoice_number": "ACME-000001",
"kind": "period",
"metadata": {
"user_id": "42"
},
"paid_at": 1794780106,
"payment": {
"amount": 5000,
"app_id": "qhf83tDc",
"created_at": 1794780106,
"currency": "XAF",
"driver": "sandbox",
"exchange_margin_bps": null,
"exchange_rate": null,
"exchange_rate_at": null,
"fee": 100,
"id": "tGfwt5dd",
"marked_by_api_key_id": null,
"marked_by_user_id": null,
"message": null,
"method_label": "Successful payment (test)",
"net": null,
"note": null,
"original_amount": 5000,
"original_currency": "XAF",
"period_id": "0kYPFwxJ",
"provider": "test",
"provider_reference": "test_ff6aaf0182bd3f1148bd",
"session_id": null,
"status": "succeeded"
},
"period_end": 1797372106,
"period_id": "0kYPFwxJ",
"period_start": 1794780106,
"promotion_code_id": null,
"subscription": {
"activated_at": 1794780106,
"app_id": "qhf83tDc",
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"created_at": 1794780106,
"current_period_end": 1797372106,
"current_period_start": 1794780106,
"customer_id": "GzeUZeSV",
"discount": null,
"ended_reason": null,
"id": "wTiODxvH",
"manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
"metadata": {
"user_id": "42"
},
"price_id": "IaFQHLTL",
"starts_at": 1794780106,
"status": "active",
"trial_ends_at": null
},
"subscription_id": "wTiODxvH"
},
"environment": "test",
"id": "01M7GKP458FZEMMQQ7VM7J4QK4",
"type": "invoice.paid"
}Event order
Event IDs sort in the order the events happened. Compare them as plain strings: a later event's ID sorts after an earlier one's. created_at is in whole seconds, so the events of one change often share it. Order events by id, not by created_at.
One change records several events at once. They come in this order:
- New subscription without a trial:
subscription.created, theninvoice.created. - Renewal:
subscription.updatedif a scheduled downgrade starts with the new period,subscription.renewed,subscription.past_dueif the new period has already started, theninvoice.created. A renewal issued before the paid period ends sendssubscription.past_dueon its own later, when the paid period ends, if it is still unpaid then. - Payment:
customer.updatedif it gave the customer their first phone number,subscription.updatedif it pays for an upgrade,session.completedif it was paid through apaymentsession or completes aplan_changesession,invoice.paid, then on the first paymentsubscription.paidand the checkout'ssession.completed, and lastsubscription.recoveredif the subscription waspast_due. - Deleting a customer:
subscription.canceledfor each subscription the delete ended, thencustomer.deleted.
Catch up on missed events
If your server missed webhooks, list the events you didn't handle and handle them now. Start without cursor, then pass each page's next_cursor until it is null, or until you reach events created 5 minutes before the newest one you handled. An event can be listed a few seconds after a newer one, so skip the ones you already handled by id rather than stopping at the first. Handle what you collected oldest first.
const base = "https://api.abuna.app/v1/apps/8ddhXCDW/events?limit=100";
const headers = { Authorization: "Bearer sk_test_..." };
const newestHandledAt = 1727600600; // created_at of the newest event you handled
const stopAt = newestHandledAt - 5 * 60;
const missed = [];
let cursor = null;
let done = false;
while (!done) {
const url = base + (cursor ? "&cursor=" + encodeURIComponent(cursor) : "");
const page = await (await fetch(url, { headers })).json();
for (const event of page.items) {
if (event.created_at < stopAt) {
done = true;
break;
}
if (!(await alreadyHandled(event.id))) missed.push(event);
}
cursor = page.next_cursor;
if (!cursor) done = true;
}
// Oldest first, in the order the events happened.
for (const event of missed.reverse()) {
await handle(event);
}Event types
Each type below lists the fields in its data. IDs are strings, amounts are integers in the currency's smallest unit, and times are Unix seconds.
Every event whose data has a subscription_id also has subscription: the full subscription object, as Retrieve a subscription returns it under subscription, as it stands right after the change the event reports. A session event whose subscription_id is null has no subscription. The lists below leave subscription out.
The subscription includes trial_ends_at: the trial end in Unix seconds, or null without a trial. Its status is trialing during a free trial.
Subscription, invoice, and plan offer events carry the subscription's metadata when the event was recorded. Session events carry the session's own metadata, not the subscription's. Pass metadata on every session you create. Without it, session events carry {}. The lists below leave metadata out unless noted.
session.completed
A session completed. A session completes at most once, and an expired session never completes. The data depends on the session's type. Every type has session_id, type, subscription_id, customer_id, metadata (the metadata you passed when you created the session), and completed_at.
checkout(Create a checkout session): without a trial, the first payment succeeded and the subscription is nowactive. A trial checkout completes instead when the free trial starts, withstatus: trialingand no payment. Without a trial,subscription.paidis recorded at the same moment. Addsprice_id, the subscription's price, andupdates, the customer'supdates. When the checkout switched a returning customer's plan instead, the session completed once the switch was confirmed, or paid for an upgrade.subscription_idis their existing subscription, and the data adds theplan_changefields below instead ofupdates.payment(Create a payment session): the invoice was paid through the session.invoice.paidis also sent. Addsinvoice_id.plan_change(Create a plan change session): the customer confirmed the change, and paid it if it was an upgrade with something to pay. Adds the fields below.cancel(Create a cancel session): the customer confirmed the cancel, scheduled or immediate.subscription.updated(scheduled) orsubscription.canceled(immediate) is also sent. Adds the fields below.portal(Create a portal session): the customer opened the customer portal for the first time. It doesn't mean they changed anything. What they do there sends its own events, likesubscription.updated,subscription.canceled,invoice.paid, andcustomer.updated. Adds nothing.
plan_change data, and a checkout's switch, adds
plan_offer_idstringThe plan offer behind the session.previous_price_idstringThe price before the change.price_idstringThe new price.directionstringupgradeordowngrade.effective_attimestampWhen the new price starts. For a downgrade, or an upgrade at the next renewal, the end of the paid period:subscription.updatedfires with the price change then.
cancel data adds
cancel_attimestampnullableWhen the subscription ends.subscription.canceledfires then. Null when it ended right away.immediatebooleantruewhen the subscription ended right away.
session.expired
An open session ran out at its expires_at, or you expired it. Abuna doesn't expire a checkout session on its own while its payment is pending. A pending subscription a checkout session started stays, and ends with checkout_expired if it isn't paid in time.
A payment session also expires when its invoice is paid another way, voided, or its subscription ends. A plan_change session also expires when its offer is replaced, canceled, or expires, or when an upgrade it started lapses unpaid. A checkout session that offered a switch expires the same way, instead of after 24 hours. A cancel session expires 24 hours after creation if the customer doesn't confirm, and a portal session 1 hour after creation if nobody opens it. See Session types.
data
session_idstringThe session.typestringThe session's type:checkout,payment,plan_change,cancel, orportal.subscription_idstringnullableThe subscription the session started or acts on. For checkout, null if the customer didn't get that far.customer_idstringnullableThe customer you passed, or the one the customer's details created. Null if neither.price_idstringnullableThe session's price, or null for payment, cancel, and portal sessions.invoice_idstringnullableThe payment session's invoice, or null for other types.plan_offer_idstringnullableThe offer of a plan_change session, or of a checkout session that offered a switch. Null otherwise.metadataobjectThe metadata you passed when you created the session.expired_attimestampWhen the session expired.
{
"customer_id": "GzeUZeSV",
"expired_at": 1794780106,
"invoice_id": null,
"metadata": {
"user_id": "42"
},
"plan_offer_id": null,
"price_id": null,
"session_id": "XYKz5u9G",
"subscription": {
"activated_at": 1794780106,
"app_id": "qhf83tDc",
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"created_at": 1794780106,
"current_period_end": 1797372106,
"current_period_start": 1794780106,
"customer_id": "GzeUZeSV",
"discount": null,
"ended_reason": null,
"id": "wTiODxvH",
"manage_token": "ac78d36db5c13e5f1bcbb67ece2ee29137a0",
"metadata": {
"user_id": "42"
},
"price_id": "IaFQHLTL",
"starts_at": 1794780106,
"status": "active",
"trial_ends_at": null
},
"subscription_id": "wTiODxvH",
"type": "cancel"
}subscription.created
A subscription was created, through the API, a checkout session, or a checkout link. It is trialing with an eligible free trial, or pending without one.
data
subscription_idstringThe new subscription.customer_idstringIts customer.price_idstringIts price.period_idstringIts free trial period, or first billing period without a trial.
subscription.paid
The first billing period was paid and the subscription is now active. After a free trial, this is the payment of the first invoice, whenever the customer pays it. A trial start doesn't send it. Later payments send invoice.paid, and subscription.recovered when they bring a past_due subscription back to active.
data
subscription_idstringThe subscription.customer_idstringIts customer.price_idstringIts price.period_idstringThe first billing period that was paid.activated_attimestampWhen the subscription started: the trial start, or the first payment without a trial.
subscription.trial_ending
A free trial is ending. Abuna sends this event at your app's normal renewal reminder lead time. Use data.subscription.trial_ends_at for the end date, in Unix seconds. The event carries the subscription and its metadata, as described above. See Free trials.
A webhook URL added from now on receives this event by default. A URL you set up before free trials existed doesn't receive it until you turn it on: a team owner opens Webhooks in the dashboard, edits Events and picks it.
subscription.renewed
After a trial, the first paid period starts at trial_ends_at, even when paid early.
Abuna issued the next billing period and its invoice. That happens before the paid period or trial ends, as many days ahead as the app's renewal_lead_days says (3 by default), or when it ends with 0. The new period starts when the paid one ends, and the customer can pay it from now. If it is still unpaid when the paid period ends, subscription.past_due follows then.
data
subscription_idstringThe subscription.period_idstringThe new billing period.amountintegerThe amount due for the new period.currencystringXAF,XOForUSD.
subscription.past_due
The paid period or trial ended and the next period isn't paid, so the subscription is now unpaid (past_due). A renewal paid before the paid period ends never sends it. Keep the customer's access while it is past_due. If the period isn't paid by its pay-by date, subscription.canceled follows with reason non_payment.
data
subscription_idstringThe subscription.metadataobjectThe subscription's metadata.
subscription.recovered
The invoice of a past_due subscription was paid, so it is active again. It comes right after invoice.paid. It also comes when a payment that arrives after a cancel for non-payment brings the subscription back; see Payments that arrive late. The data is the same as subscription.past_due.
subscription.updated
Something was scheduled or changed on a current subscription, including a trial. It fires when a cancel at the end of the trial or paid period is scheduled or undone, when the price changes (an upgrade takes effect, or a scheduled downgrade starts), when a downgrade, or an upgrade at the next renewal, is scheduled or undone, when an upgrade waiting for payment lapses, and when a new change clears an earlier one. For a scheduled cancel, subscription.canceled follows when it ends. See Changing plan.
data
subscription_idstringThe subscription.price_idstringThe price the subscription is on now.cancel_attimestampnullableWhen the subscription will end, if a cancel is scheduled. Null otherwise.cancel_at_period_endbooleantruewhile a cancel is scheduled for the end of the paid period,falseotherwise.scheduled_price_changeobjectnullableThe downgrade, or upgrade at the next renewal, scheduled for the end of the paid period. Null when none is.Show child attributesHide child attributes
price_idstringThe price the subscription moves to.effective_attimestampWhen it moves.
changeobjectWhat happened to the price. Present only when the price changed, or a downgrade or an upgrade at the next renewal was scheduled or undone. A lapsed upgrade, a cancel at the end of the period, and an upgrade that starts waiting for payment have none.Show child attributesHide child attributes
typestringprice_changed,downgrade_scheduled,downgrade_undone,upgrade_scheduled, orupgrade_undone.old_price_idstringThe price before.new_price_idstringThe new price, or the scheduled one.effective_attimestampWhen the change took effect, or when the scheduled one will.
updated_bystringmerchantwhen you changed it, orcustomerwhen they changed it in the customer portal or switched plan at a checkout. When a plan change is carried out later (a paid upgrade, a downgrade that starts, an upgrade that lapses), it is whoever asked for it:customerfrom the portal or a checkout, ormerchantwhen they confirmed a change you sent them to.
subscription.canceled
The subscription ended. It fires when the subscription really ends: right away for a cancel now, or at the end of the paid period for a scheduled cancel. Scheduling a cancel sends subscription.updated instead. The subscription in the data has ended_reason unpaid for non_payment and checkout_expired, and canceled for the others.
data
subscription_idstringThe subscription.reasonstringWhy it ended:merchant(you canceled it),customer(they canceled in the customer portal),non_payment(a renewal passed its pay-by date), orcheckout_expired(the first period was never paid). A scheduled cancel that ends keeps who scheduled it,merchantorcustomer.
plan_offer.created
A plan change session made a plan offer, a checkout offered a returning customer a switch, or you offered a change from the dashboard and Abuna sent the customer the link. A plan change session sends no email; a checkout switch sends its confirmation link by email only. Resending the link from the dashboard doesn't fire it again. The four plan_offer events share the same data.
data
offer_idstringThe offer.subscription_idstringThe subscription.price_idstringThe price offered.expires_attimestampWhen the offer stops working.
plan_offer.confirmed
The customer accepted the offer. A downgrade, or an upgrade at the next renewal, is now scheduled, or an upgrade is applied or waiting for payment. subscription.updated fires when the price changes or the change is scheduled.
plan_offer.canceled
The offer stopped before the customer accepted it. The data adds reason: merchant when you canceled it, or replaced when a new offer or the customer's own plan change took its place, or the subscription was canceled. A cancel records plan_offer.canceled just before subscription.canceled, so it has the lower event id.
plan_offer.expired
The offer reached its expires_at without being accepted.
invoice.created
Abuna issued an invoice for a new billing period, or for an upgrade. An upgrade waiting for payment gets its period dates when it is paid, and invoice.paid carries them.
data
invoice_idstringThe invoice.invoice_numberstringIts number.subscription_idstringIts subscription.period_idstringThe billing period it bills.kindstringperiodfor a billing period, orplan_changefor the first period of an upgrade.amountintegerThe amount due.creditintegerThe unused time of the current period taken off the new price.0on aperiodinvoice.discountintegerWhat the invoice's coupon took off it.0without one.amountis already after it. See the invoice object.coupon_idstringnullableThe coupon that took the discount off. Null without one.promotion_code_idstringnullableThe promotion code that brought the coupon. Null when you applied the coupon directly, without a code.currencystringXAF,XOForUSD.period_starttimestampWhen the period starts.period_endtimestampWhen the period ends.
invoice.paid
An invoice was paid. A renewal paid before its period starts is still for that period: period_start doesn't move. An invoice that was void can also become paid, when a payment the customer approved before it was voided goes through; see Payments that arrive late. The data has every invoice.created field, plus two. Its amount and currency stay the invoice's, in the price's currency.
data
paid_attimestampWhen it was paid.paymentobjectThe payment that paid the invoice, as the payment object. Itsamountandcurrencyare what the customer was charged, in FCFA for mobile money. When the invoice was in another currency,original_amount,original_currencyandexchange_rateshow the conversion.
invoice.payment_failed
A payment on an invoice failed. The invoice stays open, so the customer can try again before the pay-by date.
Some payments are reported as failed before the provider has confirmed how they ended, for example when it doesn't answer in time. Such a payment can still be paid later, usually within 7 days of when it started. A payment that failed for a stated reason, like insufficient_funds, stays failed unless the provider later reports it paid. Whenever a failed payment is paid, you get invoice.paid, and the invoice is paid. Treat invoice.paid as the final word: don't refund the customer or cut off their access on invoice.payment_failed alone.
data
subscription_idstringThe subscription.period_idstringThe billing period.invoice_idstringThe invoice.invoice_numberstringIts number.provider_referencestringThe provider's ID for the charge. Empty if it gave none.failurestringWhy it failed, with the same codes as a charge refused with402, likeinsufficient_funds. It ispayment_declinedwhen the provider gave no reason.messagestringA short note about the failure for people to read. Don't parse it, since its wording can change. Branch onfailure. Empty when there's no note.paymentobjectThe payment that failed, as the payment object, with the amount it tried to charge.
customer.updated
A customer's name, email, phone number, or metadata changed. It is also sent when a customer with no phone number pays for the first time: their phone_number is now the number that paid, and updated_by is customer.
data
customer_idstringThe customer.namestringnullableTheir name now.emailstringTheir email address now.phone_numberstringnullableTheir phone number now. Null until their first payment if they came through checkout.metadataobjectThe customer's metadata.updated_bystringmerchantwhen you changed it, orcustomerwhen they changed it in the customer portal or their first payment gave them a phone number.updatesobjectThe customer'supdatesnow.
customer.updates_changed
A customer's Telegram or WhatsApp status changed. It happens when the customer subscribes through a checkout, connects a chat app on the checkout's payment step or in their customer portal, turns it on (in Telegram, or by confirming their WhatsApp number with a code), stops it by sending "stop" in the chat, turns it off in their customer portal, or, for WhatsApp, has a number that can't get messages. A change you make to your app's chat app settings doesn't send it. Each change sends one event, and a status that stays the same sends none.
data
customer_idstringThe customer.channelstringThe chat app whose status changed:telegramorwhatsapp.statusstringThe status now:off,active,stopped, or, for Telegram,pending, and, for WhatsApp,failed.previous_statusstringThe status before.updatesobjectThe customer'supdatesnow.
{
"customer_id": "Cu5tM8rA",
"channel": "telegram",
"status": "active",
"previous_status": "pending",
"updates": {
"channel": "telegram",
"email": {
"status": "active"
},
"telegram": {
"status": "active",
"connected_at": 1727600300,
"connect_url": null
},
"whatsapp": {
"status": "off",
"connected_at": null,
"connect_url": null
}
}
}List these events to see how many customers turned a chat app on:
curl "https://api.abuna.app/v1/apps/8ddhXCDW/events?type=customer.updates_changed" \
-H "Authorization: Bearer sk_test_..."customer.deleted
You deleted a customer. Their subscriptions have ended and their personal details are erased, so the event carries none of them. When you get it, delete your own copy of the customer's details. It comes after the subscription.canceled events of that delete. Deleting the same customer again sends nothing.
data
customer_idstringThe customer.deleted_bystringmerchant: you deleted the customer, with your secret key or in the dashboard. It is the only value today.
{
"customer_id": "Cu5tM8rA",
"deleted_by": "merchant"
}price_change.scheduled
You scheduled a new amount for a price, or replaced the one that was pending. The three price_change events share the same data.
data
price_change_idstringThe change.price_idstringThe price.amountintegerThe new amount.previous_amountintegerThe amount before the change.currencystringXAF,XOForUSD.effective_attimestampMidnight at the start of the day the new amount applies from, in timezone.timezonestringYour app's time zone, likeAfrica/Douala. It is the app'stimezone.keep_current_subscribersbooleantruewhen everyone subscribed on that day keeps the old amount.
price_change.canceled
A pending change stopped before its day. The data adds reason: merchant when you canceled it, or replaced when you scheduled a new change in its place. A replacement also sends price_change.scheduled.
price_change.applied
The price's amount switched to the new one on its effective_at. The event arrives within about a minute of that time. From then on, checkouts and new subscriptions pay it. Current subscribers move to it at their next renewal, unless keep_current_subscribers is true.
notification.captured
Test mode only. Abuna wrote a message to a Test customer and kept a copy here. Most Test messages are not sent; sent says which ones were. This event never goes to your webhook URL.
data
customer_idstringThe customer. Left out forprofile_code, because the person may not be a customer yet.kindstringWhat the message is about. See customer message kinds. One more kind shows up only here:profile_code, the code for a customer's saved details at checkout.channelstringemail,telegram, orwhatsapp.recipientstringThe email address, WhatsApp number, or Telegram chat it went to, or would have gone to.subjectstringThe subject line. For a code email, it holds the code.textstringThe message, as plain text.sentbooleantruefor the three email codes Test sends as Live does:trial_email_code,email_code, andprofile_code.falsefor every other message, which was not sent.