Struct stripe::CreateCoupon

pub struct CreateCoupon<'a> {

    pub amount_off: Option<i64>,
    pub applies_to: Option<CreateCouponAppliesTo>,
    pub currency: Option<Currency>,
    pub currency_options: Option<HashMap<Currency, CreateCouponCurrencyOptions>>,
    pub duration: Option<CouponDuration>,
    pub duration_in_months: Option<i64>,
    pub expand: &'a [&'a str],
    pub id: Option<&'a str>,
    pub max_redemptions: Option<i64>,
    pub metadata: Option<Metadata>,
    pub name: Option<&'a str>,
    pub percent_off: Option<f64>,
    pub redeem_by: Option<Timestamp>,
}

The parameters for Coupon::create.

Fields

amount_off: Option<i64>

A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).

applies_to: Option<CreateCouponAppliesTo>

A hash containing directions for what this Coupon will apply discounts to.

currency: Option<Currency>

Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).

currency_options: Option<HashMap<Currency, CreateCouponCurrencyOptions>>

Coupons defined in each available currency option (only supported if amount_off is passed).

Each key must be a three-letter ISO currency code and a supported currency.

duration: Option<CouponDuration>

Specifies how long the discount will be in effect if used on a subscription.

Defaults to once.

duration_in_months: Option<i64>

Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

id: Option<&'a str>

Unique string of your choice that will be used to identify this coupon when applying it to a customer.

If you don’t want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you.

max_redemptions: Option<i64>

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid.

For example, you might have a 50% off coupon that the first 20 readers of your blog can use.

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.

name: Option<&'a str>

Name of the coupon displayed to customers on, for instance invoices, or receipts.

By default the id is shown if name is not set.

percent_off: Option<f64>

A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).

redeem_by: Option<Timestamp>

Unix timestamp specifying the last time at which the coupon can be redeemed.

After the redeem_by date, the coupon can no longer be applied to new customers.

Implementations

impl<'a> CreateCoupon<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for CreateCoupon<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateCoupon<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CreateCoupon<'a>

fn default() -> CreateCoupon<'a>

Returns the “default value” for a type.

impl<'a> Serialize for CreateCoupon<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.