Skip to main content

Billing Overview

The merchant billing surface in Ikawaari groups invoices, subscriptions, products, and customer wallet operations.

Implemented merchant routes​

Current billing routes include:

  • GET /api/v1/merchant/billing/overview
  • GET /api/v1/merchant/invoices
  • GET /api/v1/merchant/invoices/{id}
  • POST /api/v1/merchant/invoices
  • PATCH /api/v1/merchant/invoices/{id}/status
  • GET /api/v1/merchant/subscriptions
  • POST /api/v1/merchant/subscriptions
  • POST /api/v1/merchant/subscriptions/{id}/cancel
  • GET /api/v1/merchant/billing/wallet/customers/{customerId}/balance
  • GET /api/v1/merchant/billing/wallet/customers/{customerId}/transactions
  • POST /api/v1/merchant/billing/wallet/customers/{customerId}/topups
  • POST /api/v1/merchant/billing/wallet/invoices/{invoiceId}/apply

Billing overview endpoint​

GET /api/v1/merchant/billing/overview

This endpoint is the high-level operational summary for the merchant billing domain.

Domain breakdown​

Invoices​

Track invoice creation, retrieval, status changes, and wallet application.

Subscriptions​

Track recurring billing lifecycle from creation to cancellation.

Products​

Manage the product catalog used by merchant billing workflows.

Wallet​

Track customer wallet balances, transactions, top-ups, and invoice application.