1. Docs
  2. API Reference
  3. InvoiceResponseDto

InvoiceResponseDto

Example

JSON
{
  "id": "string",
  "number": "string",
  "status": "draft",
  "amount": 0,
  "amount_due": 0,
  "currency": "string",
  "description": "string",
  "period_start": "2026-04-20T12:00:00.000Z",
  "period_end": "2026-04-20T12:00:00.000Z",
  "due_date": "2026-04-20T12:00:00.000Z",
  "collection_method": "charge_automatically",
  "created": "2026-04-20T12:00:00.000Z",
  "hosted_invoice_url": "string",
  "invoice_pdf": "string"
}

Properties

14 properties 7 required

id string Required

Stripe invoice id (`in_…`).

number string Optional

Human-readable invoice number. `null` for drafts.

nullable
status enum Required

Invoice lifecycle status.

Enumdraftopenpaiduncollectiblevoid
amount number Required

Invoice total in the currency's minor unit (e.g. cents).

amount_due number Required

Amount still owed in the currency's minor unit — the figure to collect for open/uncollectible invoices; `0` once paid.

currency string Required

ISO 4217 currency code (e.g. `usd`).

description string Optional

Invoice description, or the first line item's description as a fallback (e.g. the plan name). `null` when neither is set.

nullable
period_start string Optional

Start of the billing period this invoice covers (UTC ISO).

format: date-timenullable
period_end string Optional

End of the billing period this invoice covers (UTC ISO).

format: date-timenullable
due_date string Optional

When payment is due (UTC ISO). `null` for auto-charged invoices, which Stripe never assigns a due date.

format: date-timenullable
collection_method enum Required

How Stripe collects payment. `charge_automatically` invoices have no due date; `send_invoice` invoices are manually paid by the due date.

Enumcharge_automaticallysend_invoice
created string Required

When the invoice was created (UTC ISO).

format: date-time
hosted_invoice_url string Optional

Stripe-hosted invoice page the customer can view. `null` for drafts.

nullable
invoice_pdf string Optional

Direct PDF download URL. `null` for drafts.

nullable
Was this page helpful?

Tell us how we can improve this guide.

Canopy