InvoiceListResponse

Paginated invoice list response.

items
Type: array object[] · Invoice[]
required

Invoices returned for the current page.
An invoice represents the amount due for a billing period and the payment attempts used to collect it. Subscription invoice webhook events include this object in data.object.
- id
  Type: string
  max length:
  100
  required
  
  Unique identifier for the invoice.
- created
  Type: stringFormat: date-time
  required
  
  Time at which the invoice was created.
- updated
  Type: stringFormat: date-time
  required
  
  Time at which the invoice was last updated.
- customer
  required
  
  Customer associated with the invoice. Pass expand[]=customer to include the full Customer object.
  
  Type: string · Customer ID
  max length:
  100
  
  Customer associated with the invoice. Pass expand[]=customer to include the full Customer object.
- status
  Type: stringenum
  required
  
  Current invoice status. Use the invoice event type and payment attempts to distinguish a failed collection attempt from the invoice lifecycle state.
  
  values
  draft
  
  Invoice is being prepared and is not ready for collection.
  
  open
  
  Invoice is finalized and payment is still due.
  
  paid
  
  Invoice has been fully paid.
  
  void
  
  Invoice was voided and will not be collected.
  
  uncollectible
  
  Invoice was marked uncollectible after collection was abandoned.
- billing_reason
  Type: string | nullenum
  
  Reason the invoice was created. Use this to choose the right recovery or fulfillment flow for subscription invoices.
  
  values
  subscription_create
  
  First invoice created when a subscription starts and payment is due immediately.
  
  subscription_cycle
  
  Recurring invoice created for a subscription billing period.
  
  subscription_update
  
  Invoice created because a subscription changed in a way that produced an amount due.
  
  manual
  
  Invoice created directly rather than by subscription automation.
- collection_method
  Type: stringenum
  required
  
  How Paypercut collects payment for the invoice.
  
  values
  charge_automatically
  
  Paypercut attempts to collect the invoice using a saved payment method.
  
  send_invoice
  
  Payment is expected through an invoice collection flow rather than an immediate automatic charge.
- currency
  Type: string
  required
  
  ISO 4217 currency codes (alpha3) supported for payments
- amount_due
  Type: integer · amountWithCurrencyPrecisionFormat: int64
  required
  
  Total amount due on the invoice, in the smallest currency unit.
- amount_paid
  Type: integer · amountWithCurrencyPrecisionFormat: int64
  required
  
  Amount successfully collected for the invoice, in the smallest currency unit.
- amount_remaining
  Type: integer · amountWithCurrencyPrecisionFormat: int64
  required
  
  Amount still outstanding on the invoice, in the smallest currency unit.
- period
  Type: object
  required
  
  Billing period covered by an invoice or invoice line.
- parent
  Type: object
  required
  
  Resource that caused the invoice to be created.
- lines
  Type: object
  required
  
  Invoice line items included with the invoice. Additional lines can be fetched from url when has_more is true.
- payments
  Type: object
  required
  
  Payment attempts associated with the invoice.
- status_transitions
  Type: object
  required
  
  Timestamps for important invoice lifecycle transitions.
- last_finalization_error
  Type: object · InvoiceLastFinalizationError nullable
  
  Error details from the last failed invoice finalization attempt.
- livemode
  Type: boolean
  required
  
  Has the value true if the invoice exists in live mode or false if it exists in test mode.
- metadata
  
  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  
  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  
  propertyName
  Type: string
- object
  enum
  const:
  invoice
  required
  
  String representing the object's type.
  
  values
  invoice
last_key
Type: string | null
required

Opaque cursor to pass as last_key when requesting the next page. Null when there are no more pages.