InvoiceLine

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.

    • type
      enum
      const:  
      subscription_item_details
      required

      Resource type that produced the invoice line.

      values
      • subscription_item_details

        Line was generated from a subscription item.

    • subscription_item_details
      Type: object · InvoiceSubscriptionItemParentDetails nullable

      Subscription item context for an invoice line.

  • period
    Type: object
    required

    Billing period covered by this line item.

    • end
      Type: stringFormat: date-time
      required

      End of the billing period covered by the invoice.

    • start
      Type: stringFormat: date-time
      required

      Start of the billing period covered by the invoice.

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

    • price
      Type: string
      max length:  
      100
      required

      Price used for this invoice line.

    • product
      Type: string
      max length:  
      100
      required

      Product associated with the price.