stripe_shared/
discount.rs

1/// A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
2/// It contains information about when the discount began, when it will end, and what it is applied to.
3///
4/// Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
5///
6/// For more details see <<https://stripe.com/docs/api/discounts/object>>.
7#[derive(Clone, Debug)]
8#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
9pub struct Discount {
10    /// The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode.
11    /// Will not be present for subscription mode.
12    pub checkout_session: Option<String>,
13    /// The ID of the customer associated with this discount.
14    pub customer: Option<stripe_types::Expandable<stripe_shared::Customer>>,
15    /// If the coupon has a duration of `repeating`, the date that this discount will end.
16    /// If the coupon has a duration of `once` or `forever`, this attribute will be null.
17    pub end: Option<stripe_types::Timestamp>,
18    /// The ID of the discount object.
19    /// Discounts cannot be fetched by ID.
20    /// Use `expand[]=discounts` in API calls to expand discount IDs in an array.
21    pub id: stripe_shared::DiscountId,
22    /// The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
23    pub invoice: Option<String>,
24    /// The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
25    pub invoice_item: Option<String>,
26    /// The promotion code applied to create this discount.
27    pub promotion_code: Option<stripe_types::Expandable<stripe_shared::PromotionCode>>,
28    pub source: stripe_shared::DiscountSource,
29    /// Date that the coupon was applied.
30    pub start: stripe_types::Timestamp,
31    /// The subscription that this coupon is applied to, if it is applied to a particular subscription.
32    pub subscription: Option<String>,
33    /// The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
34    pub subscription_item: Option<String>,
35}
36#[doc(hidden)]
37pub struct DiscountBuilder {
38    checkout_session: Option<Option<String>>,
39    customer: Option<Option<stripe_types::Expandable<stripe_shared::Customer>>>,
40    end: Option<Option<stripe_types::Timestamp>>,
41    id: Option<stripe_shared::DiscountId>,
42    invoice: Option<Option<String>>,
43    invoice_item: Option<Option<String>>,
44    promotion_code: Option<Option<stripe_types::Expandable<stripe_shared::PromotionCode>>>,
45    source: Option<stripe_shared::DiscountSource>,
46    start: Option<stripe_types::Timestamp>,
47    subscription: Option<Option<String>>,
48    subscription_item: Option<Option<String>>,
49}
50
51#[allow(
52    unused_variables,
53    irrefutable_let_patterns,
54    clippy::let_unit_value,
55    clippy::match_single_binding,
56    clippy::single_match
57)]
58const _: () = {
59    use miniserde::de::{Map, Visitor};
60    use miniserde::json::Value;
61    use miniserde::{Deserialize, Result, make_place};
62    use stripe_types::miniserde_helpers::FromValueOpt;
63    use stripe_types::{MapBuilder, ObjectDeser};
64
65    make_place!(Place);
66
67    impl Deserialize for Discount {
68        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
69            Place::new(out)
70        }
71    }
72
73    struct Builder<'a> {
74        out: &'a mut Option<Discount>,
75        builder: DiscountBuilder,
76    }
77
78    impl Visitor for Place<Discount> {
79        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
80            Ok(Box::new(Builder { out: &mut self.out, builder: DiscountBuilder::deser_default() }))
81        }
82    }
83
84    impl MapBuilder for DiscountBuilder {
85        type Out = Discount;
86        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
87            Ok(match k {
88                "checkout_session" => Deserialize::begin(&mut self.checkout_session),
89                "customer" => Deserialize::begin(&mut self.customer),
90                "end" => Deserialize::begin(&mut self.end),
91                "id" => Deserialize::begin(&mut self.id),
92                "invoice" => Deserialize::begin(&mut self.invoice),
93                "invoice_item" => Deserialize::begin(&mut self.invoice_item),
94                "promotion_code" => Deserialize::begin(&mut self.promotion_code),
95                "source" => Deserialize::begin(&mut self.source),
96                "start" => Deserialize::begin(&mut self.start),
97                "subscription" => Deserialize::begin(&mut self.subscription),
98                "subscription_item" => Deserialize::begin(&mut self.subscription_item),
99
100                _ => <dyn Visitor>::ignore(),
101            })
102        }
103
104        fn deser_default() -> Self {
105            Self {
106                checkout_session: Deserialize::default(),
107                customer: Deserialize::default(),
108                end: Deserialize::default(),
109                id: Deserialize::default(),
110                invoice: Deserialize::default(),
111                invoice_item: Deserialize::default(),
112                promotion_code: Deserialize::default(),
113                source: Deserialize::default(),
114                start: Deserialize::default(),
115                subscription: Deserialize::default(),
116                subscription_item: Deserialize::default(),
117            }
118        }
119
120        fn take_out(&mut self) -> Option<Self::Out> {
121            let (
122                Some(checkout_session),
123                Some(customer),
124                Some(end),
125                Some(id),
126                Some(invoice),
127                Some(invoice_item),
128                Some(promotion_code),
129                Some(source),
130                Some(start),
131                Some(subscription),
132                Some(subscription_item),
133            ) = (
134                self.checkout_session.take(),
135                self.customer.take(),
136                self.end,
137                self.id.take(),
138                self.invoice.take(),
139                self.invoice_item.take(),
140                self.promotion_code.take(),
141                self.source.take(),
142                self.start,
143                self.subscription.take(),
144                self.subscription_item.take(),
145            )
146            else {
147                return None;
148            };
149            Some(Self::Out {
150                checkout_session,
151                customer,
152                end,
153                id,
154                invoice,
155                invoice_item,
156                promotion_code,
157                source,
158                start,
159                subscription,
160                subscription_item,
161            })
162        }
163    }
164
165    impl Map for Builder<'_> {
166        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
167            self.builder.key(k)
168        }
169
170        fn finish(&mut self) -> Result<()> {
171            *self.out = self.builder.take_out();
172            Ok(())
173        }
174    }
175
176    impl ObjectDeser for Discount {
177        type Builder = DiscountBuilder;
178    }
179
180    impl FromValueOpt for Discount {
181        fn from_value(v: Value) -> Option<Self> {
182            let Value::Object(obj) = v else {
183                return None;
184            };
185            let mut b = DiscountBuilder::deser_default();
186            for (k, v) in obj {
187                match k.as_str() {
188                    "checkout_session" => b.checkout_session = FromValueOpt::from_value(v),
189                    "customer" => b.customer = FromValueOpt::from_value(v),
190                    "end" => b.end = FromValueOpt::from_value(v),
191                    "id" => b.id = FromValueOpt::from_value(v),
192                    "invoice" => b.invoice = FromValueOpt::from_value(v),
193                    "invoice_item" => b.invoice_item = FromValueOpt::from_value(v),
194                    "promotion_code" => b.promotion_code = FromValueOpt::from_value(v),
195                    "source" => b.source = FromValueOpt::from_value(v),
196                    "start" => b.start = FromValueOpt::from_value(v),
197                    "subscription" => b.subscription = FromValueOpt::from_value(v),
198                    "subscription_item" => b.subscription_item = FromValueOpt::from_value(v),
199
200                    _ => {}
201                }
202            }
203            b.take_out()
204        }
205    }
206};
207#[cfg(feature = "serialize")]
208impl serde::Serialize for Discount {
209    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
210        use serde::ser::SerializeStruct;
211        let mut s = s.serialize_struct("Discount", 12)?;
212        s.serialize_field("checkout_session", &self.checkout_session)?;
213        s.serialize_field("customer", &self.customer)?;
214        s.serialize_field("end", &self.end)?;
215        s.serialize_field("id", &self.id)?;
216        s.serialize_field("invoice", &self.invoice)?;
217        s.serialize_field("invoice_item", &self.invoice_item)?;
218        s.serialize_field("promotion_code", &self.promotion_code)?;
219        s.serialize_field("source", &self.source)?;
220        s.serialize_field("start", &self.start)?;
221        s.serialize_field("subscription", &self.subscription)?;
222        s.serialize_field("subscription_item", &self.subscription_item)?;
223
224        s.serialize_field("object", "discount")?;
225        s.end()
226    }
227}
228impl stripe_types::Object for Discount {
229    type Id = stripe_shared::DiscountId;
230    fn id(&self) -> &Self::Id {
231        &self.id
232    }
233
234    fn into_id(self) -> Self::Id {
235        self.id
236    }
237}
238stripe_types::def_id!(DiscountId);
stripe_shared/discount.rs

stripe_shared/
discount.rs
