Getting started
Overview
Recurring billing for the mobile money ecosystem: checkout, renewals, invoices, reminders and webhooks.
Abuna is recurring billing for the mobile money ecosystem, for any business that bills its customers every day, week, month or year. You start a checkout from your server and handle one webhook; Abuna sends the renewal invoices, reminders and receipts, and cancels a subscription that stays unpaid. Customers pay by MTN Mobile Money or Orange Money, into your own MeSomb, pawaPay, Notch Pay, Flutterwave or Fapshi account, or through Abuna payments.
- QuickstartTake a Test mode payment from checkout to webhook.
- GuidesSend customers to checkout, handle webhooks, connect a provider and go Live.
- API referenceEvery endpoint and object, with request and response samples.
API basics
- Build with an AI agentGive your coding agent the Abuna docs as Markdown, all at once or one page at a time.
- Authentication and API keysAuthenticate requests with your secret key, and know which key goes where.
- Test mode and Live modeBuild against Test data with the Abuna simulator or provider sandboxes, then switch to Live with the same code.
- ErrorsStatus codes, error codes, field errors, rate limits, request IDs, and how to retry safely.
- Lists and filtersWhat list endpoints return, how to page through and filter them, and how to treat IDs.
- Amounts, currencies and timestampsHow the API writes money, currencies, and times.
- API changesWhich changes Abuna makes without notice, and how much notice you get for the rest.
- ChangelogWhat changed in the Abuna API, newest first.
Guides
- SessionsSend a customer from your app to subscribe, pay, change plan or cancel, bring them back, and know for sure when they're done.
- Receiving webhooksReceive events on your server and verify that Abuna sent them.
- Free trialsOffer a free trial, grant access from webhooks, and collect the first payment when the trial ends.
- Run a sale with promotion codesCreate a coupon and a code, let customers apply it at checkout, and know what they pay and how long it lasts.
- Connecting a payment providerConnect your own MeSomb, pawaPay, Notch Pay, Flutterwave or Fapshi account, or use Abuna payments.
- Customer messagesWhat your customers get by email, Telegram and WhatsApp, and when.
- Plans and limitsWhat each Abuna plan includes, and what happens when you go over a limit.
- Going Live checklistEverything to check before you take real payments.
API reference
- AppsRead the app a key belongs to: its mode, keys, and checkout settings.
- ProductsCreate, list and rename what you sell, and copy it between Test and Live.
- PricesSet how much a product costs and how often it renews: every day, week, month or year.
- CouponsCreate the discounts customers get with a promotion code, and keep them for one payment, some months, or every payment.
- Promotion codesGive a coupon codes customers type at checkout, each with its own end date, limit and first-time rule.
- CustomersCreate, list, update and delete the people who subscribe.
- SessionsSend a customer to a hosted page to subscribe, pay an invoice, change plan, cancel or open the customer portal. Then list, read and expire those sessions.
- SubscriptionsStart, list, read, update, cancel, keep and change the plan of a customer's subscription.
- Invoices and paymentsBilling periods, their invoices and the payments made against them. List and read invoices.
- EventsThe record of everything that happened in an app, and every event type.
- Webhook deliveriesSee each webhook sent to your server, resend one or send a test.
- Customer messagesThe emails, Telegram and WhatsApp messages Abuna sent your customers.