Struct stripe::PromotionCode

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

The resource representing a Stripe “PromotionCode”.

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

Fields

id: PromotionCodeId

Unique identifier for the object.

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

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.

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: 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.

restrictions: PromotionCodesResourceRestrictions

times_redeemed: i64

Number of times this promotion code has been used.

Implementations

impl PromotionCode

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

Returns a list of your promotion codes.

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

Retrieves the promotion code with the given ID.

In order to retrieve a promotion code by the customer-facing code use list with the desired code.

pub fn update(
    client: &Client,
    id: &PromotionCodeId,
    params: UpdatePromotionCode<'_>
) -> Response<PromotionCode>

Updates the specified promotion code by setting the values of the parameters passed.

Most fields are, by design, not editable.

Trait Implementations

impl Clone for PromotionCode

fn clone(&self) -> PromotionCode

Returns a copy 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 Object for PromotionCode

type Id = PromotionCodeId

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 PromotionCode

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

Serialize this value into the given Serde serializer.