ItemResponse

  • description
    Type: string · Description nullable

    Detailed description of the product or service

  • discount
    Type: string · DiscountFormat: decimal nullable

    Item-level discount amount deducted from total_price before tax calculation

  • exemption_id
    Type: string · Exemption IdFormat: uuid nullable

    UUID of the exemption certificate that was applied to this item. Only present if the item is exempt.

  • exemption_reason
    Type: string · Exemption Reason nullable

    Human-readable reason this item is exempt (e.g., resale_certificate, government_entity, customer_fully_exempt)

  • is_exempt
    Type: boolean · Is Exempt

    True if this item was fully exempted from tax, either via an exemption certificate or customer-level exemption

  • jurisdiction_tax_breakdown
    Type: object · Jurisdiction Tax Breakdown nullable

    Per-tax-type, per-jurisdiction breakdown of tax. Outer keys are tax types (e.g. sales_tax, vat, gst). Inner keys are jurisdiction levels (e.g. country, state, county).

    • propertyName
      Type: object
      • propertyName
        Type: object · JurisdictionTaxDetail
        • gross_amount
          Type: string · Gross Amount Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          required
        • jurisdiction_type
          Type: string · Jurisdiction Type
          required
        • non_taxable_amount
          Type: string · Non Taxable Amount Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          required
        • tax_due
          Type: string · Tax Due Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          required
        • tax_rate
          Type: string · Tax Rate Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          required
        • taxable_amount
          Type: string · Taxable Amount Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          required
        • filing_taxable_jurisdiction_id
          Type: string · Filing Taxable Jurisdiction IdFormat: uuid nullable
        • jurisdiction_name
          Type: string · Jurisdiction Name nullable
        • reporting_code
          Type: string · Reporting Code nullable
        • tax_type
          Type: string · Tax Type nullable
        • transaction_type_id
          Type: string · Transaction Type IdFormat: uuid nullable
        • transaction_type_rule_id
          Type: string · Transaction Type Rule IdFormat: uuid nullable
  • manual_sales_tax_rate
    Type: string · Manual Sales Tax RateFormat: decimal nullable

    Manual tax rate override (0–1) submitted at request time. When present, bypasses automatic jurisdiction rate lookup and applies this rate directly.

  • name
    Type: string · Name
    max length:  
    256     nullable

    Short display name or label for the item

  • quantity
    Type: string · QuantityFormat: decimal nullable

    Number of units for this line item

  • relative_transaction_discount
    Type: string · Relative Transaction DiscountFormat: decimal nullable

    The portion of the transaction-level discount that was allocated to this line item, calculated pro-rata based on the item's share of the total transaction value

  • tangible_category
    Type: stringenum nullable

    Whether the item is a physical good (tangible) or a digital product or service (intangible). Affects taxability in many US jurisdictions.

    values
    • tangible
    • intangible
  • tax
    Type: object · ItemTaxSummary nullable

    Tax amounts calculated for this item

    • effective_tax_rate
      Type: string · Effective Tax RateFormat: decimal nullable

      Effective tax rate for this line item (item_total_tax ÷ total_price_after_discount)

    • total_tax
      Type: string · Total TaxFormat: decimal nullable

      Total tax calculated for this line item across all applicable jurisdiction levels

  • tax_adjustments
    Type: array string[] | null · Tax Adjustments nullable

    Adjustments applied during tax calculation (e.g., manual_tax_rate_applied).

  • tax_code
    Type: string · Tax Code
    max length:  
    256     nullable

    Product tax classification code submitted with the item. Determines tangible/digital and taxable/non-taxable classification during tax calculation.

  • taxability_reason
    Type: stringenum nullable

    The specific reason this item was classified as taxable or non-taxable (e.g., standard_rated, product_exempt, customer_exempt, zero_rated)

    values
    • customer_exempt
    • default_taxable
    • not_available
    • not_collecting
    • not_subject_to_tax
  • taxable_category
    Type: stringenum nullable

    Whether this item is subject to sales tax. Non-taxable items are excluded from the tax base.

    values
    • taxable
    • not_taxable
  • total_price
    Type: string · Total PriceFormat: decimal nullable

    Gross line item amount (unit_price × quantity) before any discounts are applied

  • total_price_after_discount
    Type: string · Total Price After DiscountFormat: decimal nullable

    Final taxable amount for this item after both item-level discount and the item's pro-rata share of the transaction-level discount have been applied. This is the amount on which tax is calculated.

  • unit_price
    Type: string · Unit PriceFormat: decimal nullable

    Per-item cost before quantity multiplication. Can be negative to represent a credit or refund line.