Checkout Line Item

  • 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

    • iso
      Type: string
      required

      Three-letter ISO currency code

    • scale
      Type: integer
      required

      Number of decimal places for this currency

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

    • currency
      Type: object · Currency
      required

      Three-letter ISO currency code

    • id
      Type: string | null
      required

      Price ID when the line item uses a catalog price.

    • product
      Type: object · Checkout Line Item Productnullable
      required
    • recurring
      Type: object · CheckoutPriceRecurringResponsenullable
      required

      Recurring billing details captured for a Checkout line-item price.

    • unit_amount
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

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

  • 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
    • display_name
      Type: string
      required
    • inclusive
      Type: boolean
      required
    • percentage
      Type: string
      required

      Decimal percentage from 0 to 100 inclusive, with at most two decimal places.

    • country
      Type: string | null
    • description
      Type: string | null
    • id
      Type: string | null

      Tax-rate ID when backed by a reusable resource. Null for inline tax-rate snapshots.

    • jurisdiction
      Type: string | null
    • 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.

      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
    • state
      Type: string | null
    • tax_type
      Type: string | null