Struct stripe::PromotionCode [−][src]
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
[src]
pub fn list(
client: &Client,
params: ListPromotionCodes<'_>
) -> Response<List<PromotionCode>>
[src]
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>
[src]
client: &Client,
id: &PromotionCodeId,
expand: &[&str]
) -> Response<PromotionCode>
Retrieves the promotion code with the given ID.
pub fn update(
client: &Client,
id: &PromotionCodeId,
params: UpdatePromotionCode<'_>
) -> Response<PromotionCode>
[src]
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
[src]
fn clone(&self) -> PromotionCode
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for PromotionCode
[src]
impl<'de> Deserialize<'de> for PromotionCode
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for PromotionCode
[src]
type Id = PromotionCodeId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for PromotionCode
[src]
Auto Trait Implementations
impl RefUnwindSafe for PromotionCode
[src]
impl Send for PromotionCode
[src]
impl Sync for PromotionCode
[src]
impl Unpin for PromotionCode
[src]
impl UnwindSafe for PromotionCode
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,