CheckoutSessionLineItemsListResponse

Paginated Checkout Session line-item response.

  • items
    Type: array object[] · Checkout Line Item[]
    required
    • amount_discount
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

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

    • amount_subtotal
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

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

    • amount_tax
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

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

    • amount_total
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

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

    • currency
      Type: object · Currency
      required

      Three-letter ISO currency code

    • description
      Type: string | null
      required
    • id
      Type: string
      required
    • position
      Type: integer Format: int32
      required

      Signed 32-bit integers (commonly used integer type).

    • price
      Type: object · Checkout Line Item Pricenullable
      required

      Resolved price for the line item.

    • quantity
      Type: integer Format: int64
      required

      Signed 64-bit integers (long type).

    • tax_behavior
      Type: string · CheckoutTaxBehaviorenum
      required

      Whether line-item tax is added to the price or included in it. unspecified behaves as exclusive.

      values
      • unspecified

        No tax behavior was explicitly selected; tax is treated as exclusive.

      • exclusive

        Tax is added on top of the line-item price.

      • inclusive

        Tax is included in the line-item price.

    • tax_rates
      Type: array object[] · Checkout Tax Rate[]
      required
  • last_key
    Type: string | null
    required

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