The Tax Transaction object 

Attributes

• idstring

  Unique identifier for the transaction.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• currencystring

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customer_detailsobject

  The customer’s details, such as address and tax IDs.

  Hide child attributes

  • customer_details.addressnullable object

    The customer’s postal address (for example, home or business location).

    Hide child attributes

    • customer_details.address.citynullable string

      City, district, suburb, town, or village.

    • customer_details.address.countrystring

      Two-letter country code (ISO 3166-1 alpha-2).

    • customer_details.address.line1nullable string

      Address line 1 (e.g., street, PO Box, or company name).

    • customer_details.address.line2nullable string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • customer_details.address.postal_codenullable string

      ZIP or postal code.

    • customer_details.address.statenullable string

      State/province as an ISO 3166-2 subdivision code, without country prefix. Example: “NY” or “TX”.

  • customer_details.address_sourcenullable enum

    The type of customer address provided.

    Possible enum values

    billing Denotes the address as billing address.

    shipping Denotes the address as shipping address.

  • customer_details.ip_addressnullable string

    The customer’s IP address (IPv4 or IPv6).

  • customer_details.tax_idsarray of objects

    The customer’s tax IDs (for example, EU VAT numbers).

    Hide child attributes

    • customer_details.tax_ids.typeenum

      The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, or unknown

      Possible enum values

      ad_nrt

      ae_trn

      ar_cuit

      au_abn

      au_arn

      bg_uic

      bh_vat

      bo_tin

      br_cnpj

      br_cpf

      Show 71 more

    • customer_details.tax_ids.valuestring

      The value of the tax ID.

  • customer_details.taxability_overrideenum

    The taxability override used for taxation.

    Possible enum values

    customer_exempt The customer is exempt of tax.

    none No taxability override (default).

    reverse_charge The customer is entitled to reverse charge tax treatment.

• line_itemsnullable objectExpandable

  The tax collected or refunded, by line item.

  Hide child attributes

  • line_items.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • line_items.dataarray of objects

    Details about each object.

    Hide child attributes

    • line_items.data.idstring

      Unique identifier for the object.

    • line_items.data.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • line_items.data.amountinteger

      The line item amount in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.

    • line_items.data.amount_taxinteger

      The amount of tax calculated for this line item, in the smallest currency unit.

    • line_items.data.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • line_items.data.metadatanullable object

      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.

    • line_items.data.productnullable string

      The ID of an existing Product.

    • line_items.data.quantityinteger

      The number of units of the item being purchased. For reversals, this is the quantity reversed.

    • line_items.data.referencestring

      A custom identifier for this line item in the transaction.

    • line_items.data.reversalnullable object

      If type=reversal, contains information about what was reversed.

      Hide child attributes

      • line_items.data.reversal.original_line_itemstring

        The id of the line item to reverse in the original transaction.

    • line_items.data.tax_behaviorenum

      Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes.

      Possible enum values

      exclusive Taxes are calculated on top of the line item amount (default).

      inclusive Taxes are included in the line item amount.

    • line_items.data.tax_codestring

      The tax code ID used for this resource.

    • line_items.data.typeenum

      If reversal, this line item reverses an earlier transaction.

      Possible enum values

      reversal Represents a partial or full reversal of an earlier transaction.

      transaction Represents a customer sale or order.

  • line_items.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • line_items.urlstring

    The URL where this list can be accessed.

• metadatanullable object

  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.

• referencestring

  A custom unique identifier, such as ‘myOrder_123’.

• typeenum

  If reversal, this transaction reverses an earlier transaction.

  Possible enum values

  reversal Represents a partial or full reversal of an earlier transaction.

  transaction Represents a customer sale or order.

More attributes

Collapse all

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• customernullable string

  The ID of an existing Customer used for the resource.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• posted_attimestamp

  The Unix timestamp representing when the tax liability is assumed or reduced.

• reversalnullable object

  If type=reversal, contains information about what was reversed.

  Hide child attributes

  • reversal.original_transactionnullable string

    The id of the reversed Transaction object.

• ship_from_detailsnullable object

  The details of the ship from location, such as the address.

  Hide child attributes

  • ship_from_details.addressobject

    The address from which the goods in the transaction are shipped from.

    Hide child attributes

    • ship_from_details.address.citynullable string

      City, district, suburb, town, or village.

    • ship_from_details.address.countrystring

      Two-letter country code (ISO 3166-1 alpha-2).

    • ship_from_details.address.line1nullable string

      Address line 1 (e.g., street, PO Box, or company name).

    • ship_from_details.address.line2nullable string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • ship_from_details.address.postal_codenullable string

      ZIP or postal code.

    • ship_from_details.address.statenullable string

      State/province as an ISO 3166-2 subdivision code, without country prefix. Example: “NY” or “TX”.

• shipping_costnullable object

  The shipping cost details for the transaction.

  Hide child attributes

  • shipping_cost.amountinteger

    The shipping amount in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.

  • shipping_cost.amount_taxinteger

    The amount of tax calculated for shipping, in the smallest currency unit.

  • shipping_cost.shipping_ratenullable string

    The ID of an existing ShippingRate.

  • shipping_cost.tax_behaviorenum

    Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes.

    Possible enum values

    exclusive Taxes are calculated on top of the shipping cost amount (default).

    inclusive Taxes are included in the shipping cost amount.

  • shipping_cost.tax_codestring

    The tax code ID used for shipping.

• tax_datetimestamp

  Timestamp of date at which the tax rules and rates in effect applies for the calculation.