Skip to content
TUMR DOCS
Docsapi referencePartner billing and balances

Partner billing and balances

Read commissions, payable balance, invoices and prepaid pool capacity.

  • GET /console/billing/balance/?organization={id}: commission totals and available_for_payout. A partner key needs distribution:billing:read.
  • GET /console/commissions/?organization={id}: accrual rows and summary for a signed-in partner member.
  • POST /console/billing/payouts/: request the full payable commission balance to the owner wallet's verified bank account. Signed-in owner or admin only; partner keys cannot withdraw.
  • GET /console/billing/invoices/?organization={id}: partner invoices.
  • GET /console/wholesale/status/?organization={id} and GET /console/wholesale/catalog/?organization={id}: current reseller status and prices.
  • POST /console/wholesale/subscription/start/ and POST /console/wholesale/subscription/cancel/: reseller subscription checkout and cancellation (signed-in user or user API key).
  • GET /console/wholesale/sponsorships/, POST /console/clients/{id}/sponsorship/, GET /console/wholesale/licenses/ and POST /console/wholesale/licenses/{id}/cancel/: merchant consent and license lifecycle.
  • GET /console/distribution/status/?organization={id}, GET /console/distribution/pool/?organization={id} and GET /console/distribution/statements/?organization={id}: pack subscription, remaining face value and allocations.
  • GET /console/distribution/packs/, GET /console/distribution/eligibility/, POST /console/distribution/purchase/ and POST /console/distribution/topup/: pack catalog and funding (checkout requires a signed-in user or user API key). Public pack purchase depends on the current eligibility and margin gate; a listed pack is not necessarily on sale.

available_for_payout includes only cleared PAYABLE referral accruals. PENDING and HELD are not withdrawable. It is not the owner's wallet balance. The distribution pool is prepaid license capacity and cannot be withdrawn as cash.

The balance response includes organization, currency (NGN), commission_balances keyed by status, and available_for_payout as a decimal string. Payout requests consume the entire payable balance in the wallet currency; a requested partial amount is rejected. Payout failures return the affected accruals to PAYABLE.

curl 'https://api.tumr.app/api/v1/console/billing/balance/' \ -H 'Authorization: Bearer tumr_pk_YOUR_SECRET'