InvoiceLineCollection

Invoice line items included with the invoice. Additional lines can be fetched from url when has_more is true.

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

    Line items on 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.

    • currency
      Type: string
      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
      required

      Resource that produced the invoice line.

    • period
      Type: object
      required

      Billing period covered by this line item.

    • quantity
      Type: integerFormat: int64
      required

      Quantity billed for the line item.

    • metadata

      Merchant-defined metadata attached to this line item.

      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
    • pricing
      Type: object · InvoicePricingSnapshot nullable

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

  • has_more
    Type: boolean
    required

    Whether more line items are available after the items returned in data.

  • object
    enum
    const:  
    list
    required

    String representing the collection type.

    values
    • list
  • url
    Type: string
    required

    API URL that can be used to list the full invoice line collection.