Struct PromotionCode

pub struct PromotionCode {

    pub active: bool,
    pub code: String,
    pub coupon: Coupon,
    pub created: i64,
    pub customer: Option<Value>,
    pub expires_at: Option<i64>,
    pub id: String,
    pub livemode: bool,
    pub max_redemptions: Option<i64>,
    pub metadata: Option<Value>,
    pub object: String,
    pub restrictions: PromotionCodesResourceRestrictions,
    pub times_redeemed: i64,
}

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

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.

coupon: Coupon

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

created: i64

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

customer: Option<Value>

The customer that this promotion code can be used by.

expires_at: Option<i64>

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

id: String

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<Value>

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.

object: String

String representing the object’s type. Objects of the same type share the same value.

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 Default for PromotionCode

fn default() -> PromotionCode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PromotionCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PromotionCode

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

Formats the value using the given formatter.

impl Serialize for PromotionCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.