Get finalized billing data for a month

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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Month in YYYY-MM format (must be a completed month)

string
^[0-9a-fA-F]{24}$

Optional filter by partner ID

string
^[0-9a-fA-F]{24}$

Optional filter by organization ID

integer
1 to 100

Number of organizations per page (default: 50, max: 100). Each org produces 1 base plan row plus one row per overage tier.

integer
0 to 9007199254740991

Number of organizations to skip for pagination (default: 0)

Headers
uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json