Struct stripe::generated::billing::promotion_code::PromotionCode
source · 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: Option<Metadata>,
pub restrictions: PromotionCodesResourceRestrictions,
pub times_redeemed: i64,
}
Expand description
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: 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.
restrictions: PromotionCodesResourceRestrictions
§times_redeemed: i64
Number of times this promotion code has been used.
Implementations§
source§impl PromotionCode
impl PromotionCode
sourcepub fn list(
client: &Client,
params: &ListPromotionCodes<'_>
) -> Response<List<PromotionCode>>
pub fn list( client: &Client, params: &ListPromotionCodes<'_> ) -> Response<List<PromotionCode>>
Returns a list of your promotion codes.
sourcepub fn retrieve(
client: &Client,
id: &PromotionCodeId,
expand: &[&str]
) -> Response<PromotionCode>
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
.
sourcepub fn update(
client: &Client,
id: &PromotionCodeId,
params: UpdatePromotionCode<'_>
) -> Response<PromotionCode>
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§
source§impl Clone for PromotionCode
impl Clone for PromotionCode
source§fn clone(&self) -> PromotionCode
fn clone(&self) -> PromotionCode
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more