Struct stripe::CreateCoupon
source · [−]pub struct CreateCoupon<'a> {
pub amount_off: Option<i64>,
pub applies_to: Option<CreateCouponAppliesTo>,
pub currency: Option<Currency>,
pub duration: Option<CouponDuration>,
pub duration_in_months: Option<i64>,
pub expand: &'a [&'a str],
pub id: Option<&'a str>,
pub max_redemptions: Option<i64>,
pub metadata: Option<Metadata>,
pub name: Option<&'a str>,
pub percent_off: Option<f64>,
pub redeem_by: Option<Timestamp>,
}
Expand description
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).
applies_to: Option<CreateCouponAppliesTo>
A hash containing directions for what this Coupon will apply discounts to.
currency: Option<Currency>
Three-letter ISO code for the currency of the amount_off
parameter (required if amount_off
is passed).
duration: Option<CouponDuration>
Specifies how long the discount will be in effect if used on a subscription.
Can be forever
, once
, or repeating
.
Defaults to once
.
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.
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>
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.
Individual keys can be unset by posting an empty value to them.
All keys can be unset by posting an empty value to metadata
.
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.
Implementations
sourceimpl<'a> CreateCoupon<'a>
impl<'a> CreateCoupon<'a>
Trait Implementations
sourceimpl<'a> Clone for CreateCoupon<'a>
impl<'a> Clone for CreateCoupon<'a>
sourcefn clone(&self) -> CreateCoupon<'a>
fn clone(&self) -> CreateCoupon<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'a> Debug for CreateCoupon<'a>
impl<'a> Debug for CreateCoupon<'a>
sourceimpl<'a> Default for CreateCoupon<'a>
impl<'a> Default for CreateCoupon<'a>
sourcefn default() -> CreateCoupon<'a>
fn default() -> CreateCoupon<'a>
Returns the “default value” for a type. Read more
sourceimpl<'a> Serialize for CreateCoupon<'a>
impl<'a> Serialize for CreateCoupon<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateCoupon<'a>
impl<'a> Send for CreateCoupon<'a>
impl<'a> Sync for CreateCoupon<'a>
impl<'a> Unpin for CreateCoupon<'a>
impl<'a> UnwindSafe for CreateCoupon<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more