pub struct Coupon {Show 17 fields
pub id: CouponId,
pub amount_off: Option<i64>,
pub applies_to: Option<CouponAppliesTo>,
pub created: Option<Timestamp>,
pub currency: Option<Currency>,
pub currency_options: Option<HashMap<Currency, CouponCurrencyOption>>,
pub deleted: bool,
pub duration: Option<CouponDuration>,
pub duration_in_months: Option<i64>,
pub livemode: Option<bool>,
pub max_redemptions: Option<i64>,
pub metadata: Option<Metadata>,
pub name: Option<String>,
pub percent_off: Option<f64>,
pub redeem_by: Option<Timestamp>,
pub times_redeemed: Option<i64>,
pub valid: Option<bool>,
}
Expand description
The resource representing a Stripe “Coupon”.
For more details see https://stripe.com/docs/api/coupons/object
Fields§
§id: CouponId
Unique identifier for the object.
amount_off: Option<i64>
Amount (in the currency
specified) that will be taken off the subtotal of any invoices for this customer.
applies_to: Option<CouponAppliesTo>
§created: Option<Timestamp>
Time at which the object was created.
Measured in seconds since the Unix epoch.
currency: Option<Currency>
If amount_off
has been set, the three-letter ISO code for the currency of the amount to take off.
currency_options: Option<HashMap<Currency, CouponCurrencyOption>>
Coupons defined in each available currency option.
Each key must be a three-letter ISO currency code and a supported currency.
deleted: bool
§duration: Option<CouponDuration>
One of forever
, once
, and repeating
.
Describes how long a customer who applies this coupon will get the discount.
duration_in_months: Option<i64>
If duration
is repeating
, the number of months the coupon applies.
Null if coupon duration
is forever
or once
.
livemode: Option<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 coupon can be redeemed, in total, across all customers, before it is no longer valid.
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.
name: Option<String>
Name of the coupon displayed to customers on for instance invoices or receipts.
percent_off: Option<f64>
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
redeem_by: Option<Timestamp>
Date after which the coupon can no longer be redeemed.
times_redeemed: Option<i64>
Number of times this coupon has been applied to a customer.
valid: Option<bool>
Taking account of the above properties, whether this coupon can still be applied to a customer.
Implementations§
source§impl Coupon
impl Coupon
sourcepub fn list(client: &Client, params: &ListCoupons<'_>) -> Response<List<Coupon>>
pub fn list(client: &Client, params: &ListCoupons<'_>) -> Response<List<Coupon>>
Returns a list of your coupons.
sourcepub fn create(client: &Client, params: CreateCoupon<'_>) -> Response<Coupon>
pub fn create(client: &Client, params: CreateCoupon<'_>) -> Response<Coupon>
You can create coupons easily via the coupon management page of the Stripe dashboard.
Coupon creation is also accessible via the API if you need to create coupons on the fly. A coupon has either a percent_off
or an amount_off
and currency
.
If you set an amount_off
, that amount will be subtracted from any invoice’s subtotal.
For example, an invoice with a subtotal of $100 will have a final total of $0 if a coupon with an amount_off
of 20000 is applied to it and an invoice with a subtotal of $300 will have a final total of $100 if a coupon with an amount_off
of 20000 is applied to it.
sourcepub fn retrieve(
client: &Client,
id: &CouponId,
expand: &[&str],
) -> Response<Coupon>
pub fn retrieve( client: &Client, id: &CouponId, expand: &[&str], ) -> Response<Coupon>
Retrieves the coupon with the given ID.
sourcepub fn update(
client: &Client,
id: &CouponId,
params: UpdateCoupon<'_>,
) -> Response<Coupon>
pub fn update( client: &Client, id: &CouponId, params: UpdateCoupon<'_>, ) -> Response<Coupon>
Updates the metadata of a coupon.
Other coupon details (currency, duration, amount_off) are, by design, not editable.
sourcepub fn delete(client: &Client, id: &CouponId) -> Response<Deleted<CouponId>>
pub fn delete(client: &Client, id: &CouponId) -> Response<Deleted<CouponId>>
You can delete coupons via the coupon management page of the Stripe dashboard.
However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.
Trait Implementations§
source§impl<'de> Deserialize<'de> for Coupon
impl<'de> Deserialize<'de> for Coupon
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for Coupon
impl RefUnwindSafe for Coupon
impl Send for Coupon
impl Sync for Coupon
impl Unpin for Coupon
impl UnwindSafe for Coupon
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)