Struct stripe::ShippingRate

pub struct ShippingRate {
    pub id: ShippingRateId,
    pub active: bool,
    pub created: Timestamp,
    pub delivery_estimate: Option<ShippingRateDeliveryEstimate>,
    pub display_name: Option<String>,
    pub fixed_amount: Option<ShippingRateFixedAmount>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub tax_behavior: Option<ShippingRateTaxBehavior>,
    pub tax_code: Option<Expandable<TaxCode>>,
    pub type_: ShippingRateType,
}

The resource representing a Stripe “ShippingRate”.

For more details see https://stripe.com/docs/api/shipping_rates/object

Fields

id: ShippingRateId

Unique identifier for the object.

active: bool

Whether the shipping rate can be used for new purchases.

Defaults to true.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

delivery_estimate: Option<ShippingRateDeliveryEstimate>

The estimated range for how long shipping will take, meant to be displayable to the customer.

This will appear on CheckoutSessions.

display_name: Option<String>

The name of the shipping rate, meant to be displayable to the customer.

This will appear on CheckoutSessions.

fixed_amount: Option<ShippingRateFixedAmount>

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.

tax_behavior: Option<ShippingRateTaxBehavior>

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.

One of inclusive, exclusive, or unspecified.

tax_code: Option<Expandable<TaxCode>>

A tax code ID.

The Shipping tax code is txcd_92010001.

type_: ShippingRateType

The type of calculation to use on the shipping rate.

Can only be fixed_amount for now.

Implementations

impl ShippingRate

pub fn list(
    client: &Client,
    params: &ListShippingRates<'_>
) -> Response<List<ShippingRate>>

Returns a list of your shipping rates.

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

Creates a new shipping rate object.

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

Returns the shipping rate object with the given ID.

pub fn update(
    client: &Client,
    id: &ShippingRateId,
    params: UpdateShippingRate<'_>
) -> Response<ShippingRate>

Updates an existing shipping rate object.

Trait Implementations

impl Clone for ShippingRate

fn clone(&self) -> ShippingRate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShippingRate

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

Formats the value using the given formatter.

impl Default for ShippingRate

fn default() -> ShippingRate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShippingRate

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

Deserialize this value from the given Serde deserializer.

impl Object for ShippingRate

type Id = ShippingRateId

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 ShippingRate

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

Serialize this value into the given Serde serializer.