Struct stripe::TaxRate

pub struct TaxRate {
    pub id: TaxRateId,
    pub active: bool,
    pub country: Option<String>,
    pub created: Timestamp,
    pub description: Option<String>,
    pub display_name: String,
    pub inclusive: bool,
    pub jurisdiction: Option<String>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub percentage: f64,
    pub state: Option<String>,
}

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.

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.

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: 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

This represents the tax rate percent out of 100.

state: Option<String>

ISO 3166-2 subdivision code, without country prefix.

For example, "NY" for New York, United States.

Implementations

impl 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.

pub fn create(client: &Client, params: CreateTaxRate<'_>) -> Response<TaxRate>

Creates a new tax rate.

pub fn retrieve(
    client: &Client,
    id: &TaxRateId,
    expand: &[&str]
) -> Response<TaxRate>

Retrieves a tax rate with the given ID.

pub fn update(
    client: &Client,
    id: &TaxRateId,
    params: UpdateTaxRate<'_>
) -> Response<TaxRate>

Updates an existing tax rate.

Trait Implementations

impl Clone for TaxRate

fn clone(&self) -> TaxRate

Returns a copy of the value.

pub 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<'de> Deserialize<'de> for TaxRate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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 object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for TaxRate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.