1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::CouponId;
use crate::params::{
CurrencyMap, Deleted, Expand, List, Metadata, Object, Paginable, RangeQuery, Timestamp,
};
use crate::resources::Currency;
/// The resource representing a Stripe "Coupon".
///
/// For more details see <https://stripe.com/docs/api/coupons/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Coupon {
/// Unique identifier for the object.
pub id: CouponId,
/// Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_off: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub applies_to: Option<CouponAppliesTo>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<Timestamp>,
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
pub currency: Option<Currency>,
/// Coupons defined in each available currency option.
///
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency_options: Option<CurrencyMap<CouponCurrencyOption>>,
// Always true for a deleted object
#[serde(default)]
pub deleted: bool,
/// One of `forever`, `once`, and `repeating`.
///
/// Describes how long a customer who applies this coupon will get the discount.
#[serde(skip_serializing_if = "Option::is_none")]
pub duration: Option<CouponDuration>,
/// If `duration` is `repeating`, the number of months the coupon applies.
///
/// Null if coupon `duration` is `forever` or `once`.
#[serde(skip_serializing_if = "Option::is_none")]
pub duration_in_months: Option<i64>,
/// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
#[serde(skip_serializing_if = "Option::is_none")]
pub livemode: Option<bool>,
/// Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
#[serde(skip_serializing_if = "Option::is_none")]
pub max_redemptions: Option<i64>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Name of the coupon displayed to customers on for instance invoices or receipts.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
pub percent_off: Option<f64>,
/// Date after which the coupon can no longer be redeemed.
#[serde(skip_serializing_if = "Option::is_none")]
pub redeem_by: Option<Timestamp>,
/// Number of times this coupon has been applied to a customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub times_redeemed: Option<i64>,
/// Taking account of the above properties, whether this coupon can still be applied to a customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub valid: Option<bool>,
}
impl Coupon {
/// Returns a list of your coupons.
pub fn list(client: &Client, params: &ListCoupons<'_>) -> Response<List<Coupon>> {
client.get_query("/coupons", params)
}
/// You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) 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.
pub fn create(client: &Client, params: CreateCoupon<'_>) -> Response<Coupon> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form("/coupons", ¶ms)
}
/// Retrieves the coupon with the given ID.
pub fn retrieve(client: &Client, id: &CouponId, expand: &[&str]) -> Response<Coupon> {
client.get_query(&format!("/coupons/{}", id), Expand { expand })
}
/// Updates the metadata of a coupon.
///
/// Other coupon details (currency, duration, amount_off) are, by design, not editable.
pub fn update(client: &Client, id: &CouponId, params: UpdateCoupon<'_>) -> Response<Coupon> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form(&format!("/coupons/{}", id), ¶ms)
}
/// You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) 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.
pub fn delete(client: &Client, id: &CouponId) -> Response<Deleted<CouponId>> {
client.delete(&format!("/coupons/{}", id))
}
}
impl Object for Coupon {
type Id = CouponId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"coupon"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CouponAppliesTo {
/// A list of product IDs this coupon applies to.
pub products: Vec<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CouponCurrencyOption {
/// Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
pub amount_off: i64,
}
/// The parameters for `Coupon::create`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct CreateCoupon<'a> {
/// A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_off: Option<i64>,
/// A hash containing directions for what this Coupon will apply discounts to.
#[serde(skip_serializing_if = "Option::is_none")]
pub applies_to: Option<CreateCouponAppliesTo>,
/// Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency: Option<Currency>,
/// Coupons defined in each available currency option (only supported if `amount_off` is passed).
///
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency_options: Option<CurrencyMap<CreateCouponCurrencyOptions>>,
/// Specifies how long the discount will be in effect if used on a subscription.
///
/// Defaults to `once`.
#[serde(skip_serializing_if = "Option::is_none")]
pub duration: Option<CouponDuration>,
/// Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
#[serde(skip_serializing_if = "Option::is_none")]
pub duration_in_months: Option<i64>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// Unique string of your choice that will be used to identify this coupon when applying it to a customer.
///
/// If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
#[serde(skip_serializing_if = "Option::is_none")]
pub id: Option<&'a str>,
/// A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid.
///
/// For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
#[serde(skip_serializing_if = "Option::is_none")]
pub max_redemptions: Option<i64>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Name of the coupon displayed to customers on, for instance invoices, or receipts.
///
/// By default the `id` is shown if `name` is not set.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<&'a str>,
/// A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
#[serde(skip_serializing_if = "Option::is_none")]
pub percent_off: Option<f64>,
/// Unix timestamp specifying the last time at which the coupon can be redeemed.
///
/// After the redeem_by date, the coupon can no longer be applied to new customers.
#[serde(skip_serializing_if = "Option::is_none")]
pub redeem_by: Option<Timestamp>,
}
impl<'a> CreateCoupon<'a> {
pub fn new() -> Self {
CreateCoupon {
amount_off: Default::default(),
applies_to: Default::default(),
currency: Default::default(),
currency_options: Default::default(),
duration: Default::default(),
duration_in_months: Default::default(),
expand: Default::default(),
id: Default::default(),
max_redemptions: Default::default(),
metadata: Default::default(),
name: Default::default(),
percent_off: Default::default(),
redeem_by: Default::default(),
}
}
}
/// The parameters for `Coupon::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListCoupons<'a> {
/// A filter on the list, based on the object `created` field.
///
/// The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<RangeQuery<Timestamp>>,
/// A cursor for use in pagination.
///
/// `ending_before` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub ending_before: Option<CouponId>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// A limit on the number of objects to be returned.
///
/// Limit can range between 1 and 100, and the default is 10.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
/// A cursor for use in pagination.
///
/// `starting_after` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub starting_after: Option<CouponId>,
}
impl<'a> ListCoupons<'a> {
pub fn new() -> Self {
ListCoupons {
created: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
starting_after: Default::default(),
}
}
}
impl Paginable for ListCoupons<'_> {
type O = Coupon;
fn set_last(&mut self, item: Self::O) {
self.starting_after = Some(item.id());
}
}
/// The parameters for `Coupon::update`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct UpdateCoupon<'a> {
/// Coupons defined in each available currency option (only supported if the coupon is amount-based).
///
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency_options: Option<CurrencyMap<UpdateCouponCurrencyOptions>>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Name of the coupon displayed to customers on, for instance invoices, or receipts.
///
/// By default the `id` is shown if `name` is not set.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<&'a str>,
}
impl<'a> UpdateCoupon<'a> {
pub fn new() -> Self {
UpdateCoupon {
currency_options: Default::default(),
expand: Default::default(),
metadata: Default::default(),
name: Default::default(),
}
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateCouponAppliesTo {
/// An array of Product IDs that this Coupon will apply to.
#[serde(skip_serializing_if = "Option::is_none")]
pub products: Option<Vec<String>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateCouponCurrencyOptions {
/// A positive integer representing the amount to subtract from an invoice total.
pub amount_off: i64,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateCouponCurrencyOptions {
/// A positive integer representing the amount to subtract from an invoice total.
pub amount_off: i64,
}
/// An enum representing the possible values of an `Coupon`'s `duration` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CouponDuration {
Forever,
Once,
Repeating,
}
impl CouponDuration {
pub fn as_str(self) -> &'static str {
match self {
CouponDuration::Forever => "forever",
CouponDuration::Once => "once",
CouponDuration::Repeating => "repeating",
}
}
}
impl AsRef<str> for CouponDuration {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CouponDuration {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CouponDuration {
fn default() -> Self {
Self::Forever
}
}