Struct PromotionCode 

pub struct PromotionCode {
    pub active: bool,
    pub code: String,
    pub coupon: Coupon,
    pub created: Timestamp,
    pub customer: Option<Expandable<Customer>>,
    pub expires_at: Option<Timestamp>,
    pub id: PromotionCodeId,
    pub livemode: bool,
    pub max_redemptions: Option<i64>,
    pub metadata: Option<HashMap<String, String>>,
    pub restrictions: PromotionCodesResourceRestrictions,
    pub times_redeemed: i64,
}

A Promotion Code represents a customer-redeemable code for a coupon. You can create multiple codes for a single coupon.

If you enable promotion codes in your customer portal configuration, then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.

For more details see <https://stripe.com/docs/api/promotion_codes/object>.

Fields

active: bool

Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.

code: String

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).

coupon: Coupon

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

customer: Option<Expandable<Customer>>

The customer that this promotion code can be used by.

expires_at: Option<Timestamp>

Date at which the promotion code can no longer be redeemed.

id: PromotionCodeId

Unique identifier for the object.

livemode: bool

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

max_redemptions: Option<i64>

Maximum number of times this promotion code can be redeemed.

metadata: Option<HashMap<String, String>>

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.

restrictions: PromotionCodesResourceRestrictions

times_redeemed: i64

Number of times this promotion code has been used.

Trait Implementations

impl Clone for PromotionCode

fn clone(&self) -> PromotionCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromotionCode

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

Formats the value using the given formatter.

impl Deserialize for PromotionCode

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for PromotionCode

fn from_value(v: Value) -> Option<Self>

impl Object for PromotionCode

type Id = PromotionCodeId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for PromotionCode

type Builder = PromotionCodeBuilder