get
https://api.benjipays.com/v2/billing
Access: Requires DISTRIBUTOR actor type
Returns finalized billing data for a completed month. Used by distributors for invoicing and reconciliation. Data is locked and should match what was actually billed.
Key Differences from Usage API:
- Usage API: Real-time calculation for dashboard visibility (can query current month)
- Billing API: Finalized/locked data for invoicing (only completed months)
Availability:
- Period must be a completed month (not current or future month)
- Data available after billing runs on 1st of month (~2-3am)
- Returns 404 if billing not yet run for period
Implementation:
- Queries billingInvoices collection by apiParent.distributorExternalId and period
- Optional filters: partnerId (apiParent.partnerId), organizationId (userId)
- Offset-based pagination (limit, offset)
- Returns finalized pricing (unitPrice, total) with apiParent (type, distributorExternalId, partnerExternalId, partnerId)
Note: NFR plans are represented as $0 plans (unitPrice: 0), no separate flag.
Requires JWT authentication and 'partners:billing:read' scope.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
