pub struct TaxRate {Show 15 fields
pub id: TaxRateId,
pub active: bool,
pub country: Option<String>,
pub created: Timestamp,
pub description: Option<String>,
pub display_name: String,
pub effective_percentage: Option<f64>,
pub inclusive: bool,
pub jurisdiction: Option<String>,
pub jurisdiction_level: Option<TaxRateJurisdictionLevel>,
pub livemode: bool,
pub metadata: Option<Metadata>,
pub percentage: f64,
pub state: Option<String>,
pub tax_type: Option<TaxRateTaxType>,
}
Expand description
The resource representing a Stripe “TaxRate”.
For more details see https://stripe.com/docs/api/tax_rates/object
Fields§
§id: TaxRateId
Unique identifier for the object.
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.
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<Metadata>
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.
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
.
Implementations§
source§impl TaxRate
impl TaxRate
sourcepub fn list(
client: &Client,
params: &ListTaxRates<'_>
) -> Response<List<TaxRate>>
pub fn list( client: &Client, params: &ListTaxRates<'_> ) -> Response<List<TaxRate>>
Returns a list of your tax rates.
Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
sourcepub fn create(client: &Client, params: CreateTaxRate<'_>) -> Response<TaxRate>
pub fn create(client: &Client, params: CreateTaxRate<'_>) -> Response<TaxRate>
Creates a new tax rate.