Struct CreatePromotionCode 

pub struct CreatePromotionCode { /* private fields */ }

A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

Implementations

impl CreatePromotionCode

pub fn new(promotion: impl Into<CreatePromotionCodePromotion>) -> Self

Construct a new CreatePromotionCode.

pub fn active(self, active: impl Into<bool>) -> Self

Whether the promotion code is currently active.

pub fn code(self, code: impl Into<String>) -> Self

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).

If left blank, we will generate one automatically.

pub fn customer(self, customer: impl Into<String>) -> Self

The customer who can use this promotion code. If not set, all customers can use the promotion code.

pub fn customer_account(self, customer_account: impl Into<String>) -> Self

The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn expires_at(self, expires_at: impl Into<Timestamp>) -> Self

The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon’s redeems_by.

pub fn max_redemptions(self, max_redemptions: impl Into<i64>) -> Self

A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon’s max_redemptions.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn restrictions( self, restrictions: impl Into<CreatePromotionCodeRestrictions>, ) -> Self

Settings that restrict the redemption of the promotion code.

impl CreatePromotionCode

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreatePromotionCode

fn clone(&self) -> CreatePromotionCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePromotionCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for CreatePromotionCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreatePromotionCode

type Output = PromotionCode

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.