---
title: "InvoiceDetail"
---

> 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

- `InvoiceDetail.id` (string, required)
- `InvoiceDetail.number` (string | null, required) — Assigned when the invoice is issued.
- `InvoiceDetail.status` (string, required) — open, paid, void or uncollectible. Treat other values as unknown.
- `InvoiceDetail.overdue` (boolean, required) — Open, not carried forward, and past its due date.
- `InvoiceDetail.carriedForward` (boolean, required) — Below the minimum charge: added to the next invoice instead.
- `InvoiceDetail.carriedIntoInvoiceId` (string | null, required) — The invoice it was carried into, once there is one.
- `InvoiceDetail.periodStart` (string, required)
  - format `date-time`
- `InvoiceDetail.periodEnd` (string, required)
  - format `date-time`
- `InvoiceDetail.currency` (string, required)
- `InvoiceDetail.collectionMethod` (string | null, required) — charge_automatically (the default card) or send_invoice.
- `InvoiceDetail.totalCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.startingBalanceCents` (string, required) — Carried from earlier invoices, in cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.amountDueCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.amountPaidCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.amountRemainingCents` (string, required) — Cents.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.dueAt` (string | null, required)
  - format `date-time`
- `InvoiceDetail.issuedAt` (string | null, required) — When it was issued and numbered.
  - format `date-time`
- `InvoiceDetail.finalizedAt` (string | null, required) — The same as issuedAt.
  - format `date-time`
- `InvoiceDetail.paidAt` (string | null, required)
  - format `date-time`
- `InvoiceDetail.organizationId` (string, required)
- `InvoiceDetail.subtotalMicros` (string, required) — The lines' exact sum, in micros.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.roundingMicros` (string, required) — subtotalMicros less totalCents, in micros.
  - pattern `^-?[0-9]+(\.[0-9]+)?$`
- `InvoiceDetail.poNumber` (string | null, required)
- `InvoiceDetail.customer` (object, required) — Who it was issued to.
  - `InvoiceDetail.customer.name` (string | null, required)
  - `InvoiceDetail.customer.email` (string | null, required)
  - `InvoiceDetail.customer.address` (object | null, required) — As issued: line1, line2, city, region, postalCode, country.
- `InvoiceDetail.hostedInvoiceUrl` (string | null, required) — Stripe's payment page.
- `InvoiceDetail.paymentAttempts` (integer, required)
- `InvoiceDetail.lastPaymentError` (string | null, required)
- `InvoiceDetail.pdf` (one of, required) — Null until the PDF is delivered.
  - one of: `object`, `null`
- `InvoiceDetail.lines` (array<object>, required)
  - `InvoiceDetail.lines.position` (integer, required)
  - `InvoiceDetail.lines.kind` (string, required) — usage, other_usage (lines under half a cent) or other_projects (a service's smallest projects, past the line limit).
  - `InvoiceDetail.lines.service` (string | null, required)
  - `InvoiceDetail.lines.projectId` (string | null, required)
  - `InvoiceDetail.lines.projectName` (string | null, required) — The project's name when the invoice was drafted.
  - `InvoiceDetail.lines.projectSlug` (string | null, required)
  - `InvoiceDetail.lines.sku` (string | null, required)
  - `InvoiceDetail.lines.description` (string, required)
  - `InvoiceDetail.lines.quantity` (string, required) — In the SKU's unit.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoiceDetail.lines.unitPrice` (string | null, required) — Dollars per unit; null for folded lines and SKUs whose price changed within the period.
  - `InvoiceDetail.lines.amount` (string, required) — Exact dollars.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoiceDetail.lines.amountMicros` (string, required) — Micros.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`
  - `InvoiceDetail.lines.amountCents` (string, required) — What's billed, in cents.
    - pattern `^-?[0-9]+(\.[0-9]+)?$`


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