InvoiceLine

Individual line item that contributes to the invoice total.

  • 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.

  • amount
    Type: amountWithCurrencyPrecisionFormat: int64
    required

    Line amount in the smallest currency unit.

  • currency
    Type: CurrencyCode
    required

    ISO 4217 currency codes (alpha3) supported for payments

  • description
    Type: string
    required

    Human-readable description of the line item.

  • quantity
    Type: integerFormat: int64
    required

    Quantity billed for the line item.

  • period
    Type: InvoiceBillingPeriod
    required

    Billing period covered by this line item.

    Properties: 2
  • parent
    Type: InvoiceLineParent
    required

    Resource that produced the invoice line.

    Properties: 2
  • pricing
    Type: InvoicePricingSnapshotnullable

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

    Properties: 2
  • metadata

    Merchant-defined metadata attached to this line item.

    Merchant-defined metadata attached to this line item.

    • propertyName
      additionalPropertyType: string
  • object
    enum
    const:  
    invoice_line_item
    required

    String representing the object's type.