Contents

Usage

Fields

  • period_start required Type: string
  • period_end required Type: string

    Start of the next month (exclusive).

  • checks required Type: integer
  • billable_checks required Type: integer
  • not_charged required Type: object
  • decisions required Type: object

    The month's items per decision.

  • unit_price required Type: string

    In currency.

  • currency required Type: "gbp" "usd"

    The billing currency: gbp in the UK, usd otherwise.

  • estimated_charge required Type: string

    billable_checks × unit_price.

  • daily required Type: object[]
  • billing required Type: object
Example
{
  "period_start": "2026-09-01T00:00:00Z",
  "period_end": "2026-10-01T00:00:00Z",
  "checks": 1284,
  "billable_checks": 1247,
  "not_charged": {
    "UNREADABLE": 21,
    "NO_SIGNATURE": 16,
    "errors": 3
  },
  "decisions": {
    "AUTO_APPROVE": 512,
    "APPROVE": 474,
    "FLAG": 212,
    "FAILED": 49,
    "UNREADABLE": 21,
    "NO_SIGNATURE": 16
  },
  "unit_price": "0.50",
  "estimated_charge": "623.50",
  "currency": "gbp",
  "daily": [
    {
      "date": "2026-09-01",
      "checks": 41,
      "billable": 40
    }
  ],
  "billing": {
    "mode": "stripe",
    "status": "active"
  }
}

Where you'll see it