[−][src]Struct stripe::CreateCoupon
The parameters for Coupon::create
.
Fields
amount_off: Option<i64>
A positive integer representing the amount to subtract from an invoice total (required if percent_off
is not passed).
currency: Option<Currency>
Three-letter ISO code for the currency of the amount_off
parameter (required if amount_off
is passed).
duration: CouponDuration
Specifies how long the discount will be in effect.
Can be forever
, once
, or repeating
.
duration_in_months: Option<i64>
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.
expand: &'a [&'a str]
Specifies which fields in the response should be expanded.
id: Option<&'a str>
Unique string of your choice that will be used to identify this coupon when applying it to a customer.
This is often a specific code you'll give to your customer to use when signing up (e.g., FALL25OFF
).
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.
max_redemptions: Option<i64>
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.
metadata: Option<Metadata>
A set of key-value pairs that you can attach to a coupon object.
It can be useful for storing additional information about the coupon in a structured format.
name: Option<&'a str>
Name of the coupon displayed to customers on, for instance invoices, or receipts.
By default the id
is shown if name
is not set.
percent_off: Option<f64>
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).
redeem_by: Option<Timestamp>
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.
Methods
impl<'a> CreateCoupon<'a>
[src]
pub fn new(duration: CouponDuration) -> Self
[src]
Trait Implementations
impl<'a> Clone for CreateCoupon<'a>
[src]
fn clone(&self) -> CreateCoupon<'a>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Debug for CreateCoupon<'a>
[src]
impl<'a> Serialize for CreateCoupon<'a>
[src]
Auto Trait Implementations
impl<'a> Sync for CreateCoupon<'a>
impl<'a> Unpin for CreateCoupon<'a>
impl<'a> Send for CreateCoupon<'a>
impl<'a> UnwindSafe for CreateCoupon<'a>
impl<'a> RefUnwindSafe for CreateCoupon<'a>
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
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.
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.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Erased for T
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self