stripe_shared/
coupon.rs

1/// A coupon contains information about a percent-off or amount-off discount you
2/// might want to apply to a customer.
3/// Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),.
4/// [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more.
5/// Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
6///
7/// For more details see <<https://stripe.com/docs/api/coupons/object>>.
8#[derive(Clone, Debug)]
9#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
10pub struct Coupon {
11    /// Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
12    pub amount_off: Option<i64>,
13    pub applies_to: Option<stripe_shared::CouponAppliesTo>,
14    /// Time at which the object was created. Measured in seconds since the Unix epoch.
15    pub created: stripe_types::Timestamp,
16    /// If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
17    pub currency: Option<stripe_types::Currency>,
18    /// Coupons defined in each available currency option.
19    /// Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
20    pub currency_options: Option<
21        std::collections::HashMap<stripe_types::Currency, stripe_shared::CouponCurrencyOption>,
22    >,
23    /// One of `forever`, `once`, or `repeating`.
24    /// Describes how long a customer who applies this coupon will get the discount.
25    pub duration: stripe_shared::CouponDuration,
26    /// If `duration` is `repeating`, the number of months the coupon applies.
27    /// Null if coupon `duration` is `forever` or `once`.
28    pub duration_in_months: Option<i64>,
29    /// Unique identifier for the object.
30    pub id: stripe_shared::CouponId,
31    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
32    pub livemode: bool,
33    /// Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
34    pub max_redemptions: Option<i64>,
35    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
36    /// This can be useful for storing additional information about the object in a structured format.
37    pub metadata: Option<std::collections::HashMap<String, String>>,
38    /// Name of the coupon displayed to customers on for instance invoices or receipts.
39    pub name: Option<String>,
40    /// Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
41    /// For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
42    pub percent_off: Option<f64>,
43    /// Date after which the coupon can no longer be redeemed.
44    pub redeem_by: Option<stripe_types::Timestamp>,
45    /// Number of times this coupon has been applied to a customer.
46    pub times_redeemed: i64,
47    /// Taking account of the above properties, whether this coupon can still be applied to a customer.
48    pub valid: bool,
49}
50#[doc(hidden)]
51pub struct CouponBuilder {
52    amount_off: Option<Option<i64>>,
53    applies_to: Option<Option<stripe_shared::CouponAppliesTo>>,
54    created: Option<stripe_types::Timestamp>,
55    currency: Option<Option<stripe_types::Currency>>,
56    currency_options: Option<
57        Option<
58            std::collections::HashMap<stripe_types::Currency, stripe_shared::CouponCurrencyOption>,
59        >,
60    >,
61    duration: Option<stripe_shared::CouponDuration>,
62    duration_in_months: Option<Option<i64>>,
63    id: Option<stripe_shared::CouponId>,
64    livemode: Option<bool>,
65    max_redemptions: Option<Option<i64>>,
66    metadata: Option<Option<std::collections::HashMap<String, String>>>,
67    name: Option<Option<String>>,
68    percent_off: Option<Option<f64>>,
69    redeem_by: Option<Option<stripe_types::Timestamp>>,
70    times_redeemed: Option<i64>,
71    valid: Option<bool>,
72}
73
74#[allow(
75    unused_variables,
76    irrefutable_let_patterns,
77    clippy::let_unit_value,
78    clippy::match_single_binding,
79    clippy::single_match
80)]
81const _: () = {
82    use miniserde::de::{Map, Visitor};
83    use miniserde::json::Value;
84    use miniserde::{Deserialize, Result, make_place};
85    use stripe_types::miniserde_helpers::FromValueOpt;
86    use stripe_types::{MapBuilder, ObjectDeser};
87
88    make_place!(Place);
89
90    impl Deserialize for Coupon {
91        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
92            Place::new(out)
93        }
94    }
95
96    struct Builder<'a> {
97        out: &'a mut Option<Coupon>,
98        builder: CouponBuilder,
99    }
100
101    impl Visitor for Place<Coupon> {
102        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
103            Ok(Box::new(Builder { out: &mut self.out, builder: CouponBuilder::deser_default() }))
104        }
105    }
106
107    impl MapBuilder for CouponBuilder {
108        type Out = Coupon;
109        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
110            Ok(match k {
111                "amount_off" => Deserialize::begin(&mut self.amount_off),
112                "applies_to" => Deserialize::begin(&mut self.applies_to),
113                "created" => Deserialize::begin(&mut self.created),
114                "currency" => Deserialize::begin(&mut self.currency),
115                "currency_options" => Deserialize::begin(&mut self.currency_options),
116                "duration" => Deserialize::begin(&mut self.duration),
117                "duration_in_months" => Deserialize::begin(&mut self.duration_in_months),
118                "id" => Deserialize::begin(&mut self.id),
119                "livemode" => Deserialize::begin(&mut self.livemode),
120                "max_redemptions" => Deserialize::begin(&mut self.max_redemptions),
121                "metadata" => Deserialize::begin(&mut self.metadata),
122                "name" => Deserialize::begin(&mut self.name),
123                "percent_off" => Deserialize::begin(&mut self.percent_off),
124                "redeem_by" => Deserialize::begin(&mut self.redeem_by),
125                "times_redeemed" => Deserialize::begin(&mut self.times_redeemed),
126                "valid" => Deserialize::begin(&mut self.valid),
127                _ => <dyn Visitor>::ignore(),
128            })
129        }
130
131        fn deser_default() -> Self {
132            Self {
133                amount_off: Deserialize::default(),
134                applies_to: Deserialize::default(),
135                created: Deserialize::default(),
136                currency: Deserialize::default(),
137                currency_options: Deserialize::default(),
138                duration: Deserialize::default(),
139                duration_in_months: Deserialize::default(),
140                id: Deserialize::default(),
141                livemode: Deserialize::default(),
142                max_redemptions: Deserialize::default(),
143                metadata: Deserialize::default(),
144                name: Deserialize::default(),
145                percent_off: Deserialize::default(),
146                redeem_by: Deserialize::default(),
147                times_redeemed: Deserialize::default(),
148                valid: Deserialize::default(),
149            }
150        }
151
152        fn take_out(&mut self) -> Option<Self::Out> {
153            let (
154                Some(amount_off),
155                Some(applies_to),
156                Some(created),
157                Some(currency),
158                Some(currency_options),
159                Some(duration),
160                Some(duration_in_months),
161                Some(id),
162                Some(livemode),
163                Some(max_redemptions),
164                Some(metadata),
165                Some(name),
166                Some(percent_off),
167                Some(redeem_by),
168                Some(times_redeemed),
169                Some(valid),
170            ) = (
171                self.amount_off,
172                self.applies_to.take(),
173                self.created,
174                self.currency.take(),
175                self.currency_options.take(),
176                self.duration,
177                self.duration_in_months,
178                self.id.take(),
179                self.livemode,
180                self.max_redemptions,
181                self.metadata.take(),
182                self.name.take(),
183                self.percent_off,
184                self.redeem_by,
185                self.times_redeemed,
186                self.valid,
187            )
188            else {
189                return None;
190            };
191            Some(Self::Out {
192                amount_off,
193                applies_to,
194                created,
195                currency,
196                currency_options,
197                duration,
198                duration_in_months,
199                id,
200                livemode,
201                max_redemptions,
202                metadata,
203                name,
204                percent_off,
205                redeem_by,
206                times_redeemed,
207                valid,
208            })
209        }
210    }
211
212    impl Map for Builder<'_> {
213        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
214            self.builder.key(k)
215        }
216
217        fn finish(&mut self) -> Result<()> {
218            *self.out = self.builder.take_out();
219            Ok(())
220        }
221    }
222
223    impl ObjectDeser for Coupon {
224        type Builder = CouponBuilder;
225    }
226
227    impl FromValueOpt for Coupon {
228        fn from_value(v: Value) -> Option<Self> {
229            let Value::Object(obj) = v else {
230                return None;
231            };
232            let mut b = CouponBuilder::deser_default();
233            for (k, v) in obj {
234                match k.as_str() {
235                    "amount_off" => b.amount_off = FromValueOpt::from_value(v),
236                    "applies_to" => b.applies_to = FromValueOpt::from_value(v),
237                    "created" => b.created = FromValueOpt::from_value(v),
238                    "currency" => b.currency = FromValueOpt::from_value(v),
239                    "currency_options" => b.currency_options = FromValueOpt::from_value(v),
240                    "duration" => b.duration = FromValueOpt::from_value(v),
241                    "duration_in_months" => b.duration_in_months = FromValueOpt::from_value(v),
242                    "id" => b.id = FromValueOpt::from_value(v),
243                    "livemode" => b.livemode = FromValueOpt::from_value(v),
244                    "max_redemptions" => b.max_redemptions = FromValueOpt::from_value(v),
245                    "metadata" => b.metadata = FromValueOpt::from_value(v),
246                    "name" => b.name = FromValueOpt::from_value(v),
247                    "percent_off" => b.percent_off = FromValueOpt::from_value(v),
248                    "redeem_by" => b.redeem_by = FromValueOpt::from_value(v),
249                    "times_redeemed" => b.times_redeemed = FromValueOpt::from_value(v),
250                    "valid" => b.valid = FromValueOpt::from_value(v),
251                    _ => {}
252                }
253            }
254            b.take_out()
255        }
256    }
257};
258#[cfg(feature = "serialize")]
259impl serde::Serialize for Coupon {
260    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
261        use serde::ser::SerializeStruct;
262        let mut s = s.serialize_struct("Coupon", 17)?;
263        s.serialize_field("amount_off", &self.amount_off)?;
264        s.serialize_field("applies_to", &self.applies_to)?;
265        s.serialize_field("created", &self.created)?;
266        s.serialize_field("currency", &self.currency)?;
267        s.serialize_field("currency_options", &self.currency_options)?;
268        s.serialize_field("duration", &self.duration)?;
269        s.serialize_field("duration_in_months", &self.duration_in_months)?;
270        s.serialize_field("id", &self.id)?;
271        s.serialize_field("livemode", &self.livemode)?;
272        s.serialize_field("max_redemptions", &self.max_redemptions)?;
273        s.serialize_field("metadata", &self.metadata)?;
274        s.serialize_field("name", &self.name)?;
275        s.serialize_field("percent_off", &self.percent_off)?;
276        s.serialize_field("redeem_by", &self.redeem_by)?;
277        s.serialize_field("times_redeemed", &self.times_redeemed)?;
278        s.serialize_field("valid", &self.valid)?;
279
280        s.serialize_field("object", "coupon")?;
281        s.end()
282    }
283}
284impl stripe_types::Object for Coupon {
285    type Id = stripe_shared::CouponId;
286    fn id(&self) -> &Self::Id {
287        &self.id
288    }
289
290    fn into_id(self) -> Self::Id {
291        self.id
292    }
293}
294stripe_types::def_id!(CouponId);
295#[derive(Copy, Clone, Eq, PartialEq)]
296pub enum CouponDuration {
297    Forever,
298    Once,
299    Repeating,
300}
301impl CouponDuration {
302    pub fn as_str(self) -> &'static str {
303        use CouponDuration::*;
304        match self {
305            Forever => "forever",
306            Once => "once",
307            Repeating => "repeating",
308        }
309    }
310}
311
312impl std::str::FromStr for CouponDuration {
313    type Err = stripe_types::StripeParseError;
314    fn from_str(s: &str) -> Result<Self, Self::Err> {
315        use CouponDuration::*;
316        match s {
317            "forever" => Ok(Forever),
318            "once" => Ok(Once),
319            "repeating" => Ok(Repeating),
320            _ => Err(stripe_types::StripeParseError),
321        }
322    }
323}
324impl std::fmt::Display for CouponDuration {
325    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
326        f.write_str(self.as_str())
327    }
328}
329
330impl std::fmt::Debug for CouponDuration {
331    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
332        f.write_str(self.as_str())
333    }
334}
335impl serde::Serialize for CouponDuration {
336    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
337    where
338        S: serde::Serializer,
339    {
340        serializer.serialize_str(self.as_str())
341    }
342}
343impl miniserde::Deserialize for CouponDuration {
344    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
345        crate::Place::new(out)
346    }
347}
348
349impl miniserde::de::Visitor for crate::Place<CouponDuration> {
350    fn string(&mut self, s: &str) -> miniserde::Result<()> {
351        use std::str::FromStr;
352        self.out = Some(CouponDuration::from_str(s).map_err(|_| miniserde::Error)?);
353        Ok(())
354    }
355}
356
357stripe_types::impl_from_val_with_from_str!(CouponDuration);
358#[cfg(feature = "deserialize")]
359impl<'de> serde::Deserialize<'de> for CouponDuration {
360    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
361        use std::str::FromStr;
362        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
363        Self::from_str(&s).map_err(|_| serde::de::Error::custom("Unknown value for CouponDuration"))
364    }
365}
stripe_shared/coupon.rs

stripe_shared/
coupon.rs
