Struct stripe::CreatePrice

pub struct CreatePrice<'a> {
    pub active: Option<bool>,
    pub billing_scheme: Option<PriceBillingScheme>,
    pub currency: Currency,
    pub expand: &'a [&'a str],
    pub lookup_key: Option<&'a str>,
    pub metadata: Option<Metadata>,
    pub nickname: Option<&'a str>,
    pub product: Option<IdOrCreate<'a, CreateProduct<'a>>>,
    pub product_data: Option<CreatePriceProductData>,
    pub recurring: Option<CreatePriceRecurring>,
    pub tiers: Option<Vec<CreatePriceTiers>>,
    pub tiers_mode: Option<PriceTiersMode>,
    pub transfer_lookup_key: Option<bool>,
    pub transform_quantity: Option<CreatePriceTransformQuantity>,
    pub unit_amount: Option<i64>,
    pub unit_amount_decimal: Option<&'a str>,
}

The parameters for Price::create.

Fields

active: Option<bool>

Whether the price can be used for new purchases.

Defaults to true.

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.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

lookup_key: Option<&'a str>

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

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

nickname: Option<&'a str>

A brief description of the price, hidden from customers.

product: Option<IdOrCreate<'a, CreateProduct<'a>>>

The ID of the product that this price will belong to.

product_data: Option<CreatePriceProductData>

These fields can be used to create a new product that this price will belong to.

recurring: Option<CreatePriceRecurring>

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

tiers: Option<Vec<CreatePriceTiers>>

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 successively change as the quantity grows.

transfer_lookup_key: Option<bool>

If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

transform_quantity: Option<CreatePriceTransformQuantity>

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

Cannot be combined with tiers.

unit_amount: Option<i64>

A positive integer in %s (or 0 for a free price) representing how much to charge.

unit_amount_decimal: Option<&'a str>

Same as unit_amount, but accepts a decimal value in %s with at most 12 decimal places.

Only one of unit_amount and unit_amount_decimal can be set.

Implementations

impl<'a> CreatePrice<'a>

pub fn new(currency: Currency) -> Self

Trait Implementations

impl<'a> Clone for CreatePrice<'a>

fn clone(&self) -> CreatePrice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreatePrice<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreatePrice<'a>

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

Serialize this value into the given Serde serializer.