ShippingFeeResponse

  • 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 applied to the shipping fee. When present, bypasses automatic jurisdiction rate lookup.

  • tangible_category
    Type: stringenum nullable

    Tangibility classification of the shipping fee

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

    Tax amounts calculated on the shipping fee

    • 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_code
    Type: string · Tax Code nullable

    Product tax classification code for the shipping fee, used to determine taxability in each jurisdiction

  • taxability_reason
    Type: stringenum nullable

    The specific reason the shipping fee was classified as taxable or non-taxable (e.g., standard_rated, customer_exempt, manual_rate, not_available)

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

    Whether the shipping fee is subject to sales tax in the applicable jurisdiction

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

    Shipping cost submitted on the request. Taxed only if the transaction has at least one taxable item.

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

    Shipping amount used as the tax base after any applicable discounts