The Tax Setting object 

Tax
Tax Settings
The Tax Setting object

Attributes

  • objectstring

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

  • defaultsobject

    Default configuration to be used on Stripe Tax calculations.

    • defaults.tax_behaviornullable enum

      Default tax behavior used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item’s price has a tax behavior set, it will take precedence over the default tax behavior.

      Possible enum values
      exclusive

      Taxes are calculated on top of the line item amount.

      inclusive

      Taxes are included in the line item amount.

      inferred_by_currency

      Stripe will use the price currency to define whether the tax should be added on top of the price (excluded) or included in the price.

    • defaults.tax_codenullable string

      Default tax code used to classify your products and prices.

  • head_officenullable object

    The place where your business is located.

    • head_office.addressobject

      The location of the business for tax purposes.

      • head_office.address.citynullable string

        City, district, suburb, town, or village.

      • head_office.address.countrynullable string

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

      • head_office.address.line1nullable string

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

      • head_office.address.line2nullable string

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

      • head_office.address.postal_codenullable string

        ZIP or postal code.

      • head_office.address.statenullable string

        State, county, province, or region.

  • livemodeboolean

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

  • statusenum

    The status of the Tax Settings.

    Possible enum values
    active

    Tax Settings have the required information and ready for tax calculations.

    pending

    Tax Settings missing some required information and not ready for tax calculations. Check status_details field for more.

  • status_detailsobject

    Information about the status.

    • status_details.activenullable object

      If status is active, this hash contains further details about the Settings.

    • status_details.pendingnullable object

      If status is pending, this hash contains further details about the Settings.

      • status_details.pending.missing_fieldsnullable array of strings

        The list of missing fields that are required to perform calculations. It includes the entry head_office when the status is pending. It is recommended to set the optional values even if they aren’t listed as required for calculating taxes. Calculations can fail if missing fields aren’t explicitly provided on every call.

The Tax Setting object
{
"object": "tax.settings",
"defaults": {
"tax_behavior": null,
"tax_code": "txcd_10000000"
},
"head_office": {
"address": {
"city": null,
"country": "US",
"line1": null,
"line2": null,
"postal_code": null,
"state": "CA"
}
},
"livemode": false,
"status": "active",
"status_details": {
"active": {}
}
}