InvoiceLineListResponse

Paginated invoice line-item response.

  • items
    Type: array object[] · InvoiceLine[]
    required

    Invoice line items returned for the current page.

    Individual line item that contributes to the invoice total.

    • amount
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

      Line amount in the smallest currency unit.

      Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

    • currency
      Type: string · CurrencyCode
      required

      ISO 4217 currency codes (alpha3) supported for payments

    • description
      Type: string
      required

      Human-readable description of the line item.

    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the invoice line.

    • invoice
      Type: string
      max length:  
      100
      required

      Invoice that contains this line.

    • object
      enum
      const:  
      invoice_line_item
      required

      String representing the object's type.

      values
      • invoice_line_item
    • parent
      Type: object · InvoiceLineParent
      required

      Resource that produced the invoice line.

    • period
      Type: object · InvoiceBillingPeriod
      required

      Billing period covered by this line item.

    • quantity
      Type: integer Format: int64
      required

      Quantity billed for the line item.

    • metadata

      Merchant-defined metadata attached to this line item.

      Merchant-defined metadata attached to this line item.

      • propertyName
        Type: string
    • pricing
      Type: object · InvoicePricingSnapshotnullable

      Price and product snapshot used to calculate this line. Null when the line is not price-backed.

      Price and product identifiers captured when the invoice line was created.

  • last_key
    Type: string | null
    required

    When present, use this cursor as last_key to retrieve the next page.

  • object
    enum
    const:  
    list
    required
    values
    • list
  • url
    Type: string
    required

    API URL for this invoice's line-item collection.