---
title: "InvoicePage"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Billing API

## Fields

- `InvoicePage.invoices` (array<object>, required) — Newest period first.
  - `InvoicePage.invoices.id` (string, required)
  - `InvoicePage.invoices.number` (string | null, required) — Assigned when the invoice is issued.
  - `InvoicePage.invoices.status` (string, required) — open, paid, void or uncollectible. Treat other values as unknown.
  - `InvoicePage.invoices.overdue` (boolean, required) — Open, not carried forward, and past its due date.
  - `InvoicePage.invoices.carriedForward` (boolean, required) — Below the minimum charge: added to the next invoice instead.
  - `InvoicePage.invoices.carriedIntoInvoiceId` (string | null, required) — The invoice it was carried into, once there is one.
  - `InvoicePage.invoices.periodStart` (string, required)
    - format `date-time`
  - `InvoicePage.invoices.periodEnd` (string, required)
    - format `date-time`
  - `InvoicePage.invoices.currency` (string, required)
  - `InvoicePage.invoices.collectionMethod` (string | null, required) — charge_automatically (the default card) or send_invoice.
  - `InvoicePage.invoices.totalCents` (string, required) — Cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoicePage.invoices.startingBalanceCents` (string, required) — Carried from earlier invoices, in cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoicePage.invoices.amountDueCents` (string, required) — Cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoicePage.invoices.amountPaidCents` (string, required) — Cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoicePage.invoices.amountRemainingCents` (string, required) — Cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoicePage.invoices.dueAt` (string | null, required)
    - format `date-time`
  - `InvoicePage.invoices.issuedAt` (string | null, required) — When it was issued and numbered.
    - format `date-time`
  - `InvoicePage.invoices.finalizedAt` (string | null, required) — The same as issuedAt.
    - format `date-time`
  - `InvoicePage.invoices.paidAt` (string | null, required)
    - format `date-time`
- `InvoicePage.nextCursor` (string | null, required) — Pass as cursor for the next page; null on the last.


Source: https://docs.ezghcloud.com/billing-api/schemas/InvoicePage/index.md