Struct TaxRate

pub struct TaxRate {

    pub active: bool,
    pub country: Option<String>,
    pub created: Timestamp,
    pub description: Option<String>,
    pub display_name: String,
    pub effective_percentage: Option<f64>,
    pub flat_amount: Option<TaxRateFlatAmount>,
    pub id: TaxRateId,
    pub inclusive: bool,
    pub jurisdiction: Option<String>,
    pub jurisdiction_level: Option<TaxRateJurisdictionLevel>,
    pub livemode: bool,
    pub metadata: Option<HashMap<String, String>>,
    pub percentage: f64,
    pub rate_type: Option<TaxRateRateType>,
    pub state: Option<String>,
    pub tax_type: Option<TaxRateTaxType>,
}

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

Related guide: Tax rates

For more details see <https://stripe.com/docs/api/tax_rates/object>.

Fields

active: bool

Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

country: Option<String>

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

created: Timestamp

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

description: Option<String>

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

display_name: String

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

effective_percentage: Option<f64>

Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,. this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

flat_amount: Option<TaxRateFlatAmount>

The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

id: TaxRateId

Unique identifier for the object.

inclusive: bool

This specifies if the tax rate is inclusive or exclusive.

jurisdiction: Option<String>

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

jurisdiction_level: Option<TaxRateJurisdictionLevel>

The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

livemode: bool

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

metadata: Option<HashMap<String, String>>

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.

percentage: f64

Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

rate_type: Option<TaxRateRateType>

Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

state: Option<String>

ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

tax_type: Option<TaxRateTaxType>

The high-level tax type, such as vat or sales_tax.

Trait Implementations

impl Clone for TaxRate

fn clone(&self) -> TaxRate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaxRate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for TaxRate

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for TaxRate

fn from_value(v: Value) -> Option<Self>

impl Object for TaxRate

type Id = TaxRateId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for TaxRate

type Builder = TaxRateBuilder