Struct stripe::Price

pub struct Price {
    pub id: PriceId,
    pub active: Option<bool>,
    pub billing_scheme: Option<PriceBillingScheme>,
    pub created: Option<Timestamp>,
    pub currency: Option<Currency>,
    pub deleted: bool,
    pub livemode: Option<bool>,
    pub lookup_key: Option<String>,
    pub metadata: Metadata,
    pub nickname: Option<String>,
    pub product: Option<Expandable<Product>>,
    pub recurring: Option<Recurring>,
    pub tiers: Option<Vec<PriceTier>>,
    pub tiers_mode: Option<PriceTiersMode>,
    pub transform_quantity: Option<TransformQuantity>,
    pub type_: Option<PriceType>,
    pub unit_amount: Option<i64>,
    pub unit_amount_decimal: Option<String>,
}

The resource representing a Stripe "Price".

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

Fields

id: PriceId

Unique identifier for the object.

active: Option<bool>

Whether the price can be used for new purchases.

billing_scheme: Option<PriceBillingScheme>

Describes how to compute the price per period.

Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

deleted: bool

livemode: Option<bool>

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

lookup_key: Option<String>

A lookup key used to retrieve prices dynamically from a static string.

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.

nickname: Option<String>

A brief description of the plan, hidden from customers.

product: Option<Expandable<Product>>

The ID of the product this price is associated with.

recurring: Option<Recurring>

The recurring components of a price such as interval and usage_type.

tiers: Option<Vec<PriceTier>>

Each element represents a pricing tier.

This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

tiers_mode: Option<PriceTiersMode>

Defines if the tiering price should be graduated or volume based.

In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.

transform_quantity: Option<TransformQuantity>

Apply a transformation to the reported usage or set quantity before computing the amount billed.

Cannot be combined with tiers.

type_: Option<PriceType>

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

unit_amount: Option<i64>

The unit amount in %s to be charged, represented as a whole integer if possible.

unit_amount_decimal: Option<String>

The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places.

Implementations

impl Price

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

Returns a list of your prices.

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

Creates a new price for an existing product.

The price can be recurring or one-time.

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

Retrieves the price with the given ID.

pub fn update(
    client: &Client,
    id: &PriceId,
    params: UpdatePrice<'_>
) -> Response<Price>

Updates the specified price by setting the values of the parameters passed.

Any parameters not provided are left unchanged.

Trait Implementations

impl Clone for Price

fn clone(&self) -> Price

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Price

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Price

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

Deserialize this value from the given Serde deserializer.

impl Object for Price

type Id = PriceId

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 Price

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

Serialize this value into the given Serde serializer.