ONYX
Docs

Billing API

List ledger transactions and invoices for partner reconciliation.

Billing API helps finance and operations teams reconcile partner activity.

Use it to review ledger transactions, match charges to orders, review invoices, and investigate credits, refunds, releases, and monthly commitment adjustments.

Do not use billing endpoints as a customer-facing activity feed. Billing records exist for partner finance, operations, support, and reconciliation.

List Ledger Transactions

GET /v1/partner/ledger/transactions

Returns ledger entries for the approved partner account.

{
  "data": {
    "transactions": [
      {
        "ledgerEntryId": "pp_ledger_10001",
        "type": "capture",
        "currency": "USD",
        "amountUsd": 11.6,
        "orderId": "pp_order_10001",
        "invoiceId": null,
        "description": "Order charge",
        "createdAt": "2026-06-11T00:00:00.000Z"
      }
    ]
  }
}

Ledger Types

Current ledger entry types are:

  • reserve
  • capture
  • release
  • credit
  • refund
  • monthly_minimum_true_up

Use ledger type, amount, order ID, invoice ID, and timestamp together when reconciling.

List Invoices

GET /v1/partner/invoices

Returns invoice summaries for the approved partner account.

{
  "data": {
    "invoices": [
      {
        "invoiceId": "pp_invoice_2026_06",
        "periodStart": "2026-06-01T00:00:00.000Z",
        "periodEnd": "2026-06-30T23:59:59.999Z",
        "currency": "USD",
        "grossProfitUsd": 0,
        "monthlyMinimumCommitmentUsd": 2500,
        "trueUpUsd": 0,
        "totalDueUsd": 0,
        "status": "draft"
      }
    ]
  }
}

Invoice States

Current invoice states are:

  • draft
  • issued
  • paid
  • void

Use invoice status before treating an amount as final.

Reconciliation

Match order ID, partner order ID, package ID, ledger entry, invoice period, refund or credit state, and support case when one exists.

Do not send private payment details through ordinary support channels.