Getting started
Overview
Add subscriptions paid by mobile money to your app with the Abuna API, hosted pages, and webhooks.
Abuna bills your customers each period, sends them pay links, and tells your server what happened. Customers pay through your own pawaPay, Notch Pay, or Flutterwave account, so the money goes straight to you. More providers are coming.
- QuickstartTake a Test mode payment from checkout to webhook.
- GuidesSend customers to hosted pages, receive webhooks, and go live.
- API referenceEvery endpoint and object, with request and response samples.
API basics
- 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, and field errors, and how to handle each.
- Lists and filtersWhat list endpoints return, how to filter them, and how many rows they send.
- Amounts, currencies and timestampsHow the API writes money, currencies, and times.
Guides
- SessionsSend a customer from your app to subscribe, pay an invoice, change plan, cancel, or manage billing, bring them back, and know for sure when they're done.
- Receiving webhooksReceive events on your server and verify that Abuna sent them.
- Connecting a payment providerConnect your own pawaPay, Notch Pay, or Flutterwave account so customers pay you directly. More are coming.
- Customer notificationsWhat your customers receive by email and Telegram, 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 the things you sell.
- PricesSet how much a product costs and how often it renews.
- CustomersCreate, list, and update the people who subscribe.
- SessionsSend a customer to a hosted page to start a subscription, 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 to a price.
- Invoices and paymentsBilling periods, their invoices, and the payments made against them, and how to 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.
- NoticesThe emails and Telegram messages Abuna sent your customers.