Struct CreateCouponInput 

pub struct CreateCouponInput {

    pub name: String,
    pub code: String,
    pub coupon_type: CouponType,
    pub amount_cents: Option<i64>,
    pub amount_currency: Option<String>,
    pub percentage_rate: Option<String>,
    pub frequency: CouponFrequency,
    pub frequency_duration: Option<i32>,
    pub reusable: Option<bool>,
    pub limited_plans: Option<bool>,
    pub plan_codes: Option<Vec<String>>,
    pub limited_billable_metrics: Option<bool>,
    pub billable_metric_codes: Option<Vec<String>>,
    pub expiration: CouponExpiration,
    pub expiration_at: Option<String>,
}

Input for creating a coupon.

This struct contains the data needed to create a new coupon.

Fields

name: String

code: String

coupon_type: CouponType

amount_cents: Option<i64>

amount_currency: Option<String>

percentage_rate: Option<String>

frequency: CouponFrequency

frequency_duration: Option<i32>

reusable: Option<bool>

limited_plans: Option<bool>

plan_codes: Option<Vec<String>>

limited_billable_metrics: Option<bool>

billable_metric_codes: Option<Vec<String>>

expiration: CouponExpiration

expiration_at: Option<String>

Implementations

impl CreateCouponInput

pub fn fixed_amount( name: String, code: String, amount_cents: i64, amount_currency: String, frequency: CouponFrequency, expiration: CouponExpiration, ) -> Self

Creates a new fixed amount coupon input.

Arguments

• name - The name of the coupon
• code - The unique code for the coupon
• amount_cents - The discount amount in cents
• amount_currency - The currency code (e.g., “USD”)
• frequency - The frequency of the coupon application
• expiration - The expiration policy for the coupon

Returns

A new CreateCouponInput instance for a fixed amount coupon

pub fn percentage( name: String, code: String, percentage_rate: String, frequency: CouponFrequency, expiration: CouponExpiration, ) -> Self

Creates a new percentage coupon input.

Arguments

• name - The name of the coupon
• code - The unique code for the coupon
• percentage_rate - The discount percentage (e.g., “10.5” for 10.5%)
• frequency - The frequency of the coupon application
• expiration - The expiration policy for the coupon

Returns

A new CreateCouponInput instance for a percentage coupon

pub fn with_frequency_duration(self, duration: i32) -> Self

Sets the frequency duration for recurring coupons.

Arguments

• duration - The number of billing periods the coupon applies to

Returns

The modified input instance for method chaining.

pub fn with_reusable(self, reusable: bool) -> Self

Sets whether the coupon is reusable.

Arguments

• reusable - Whether the coupon can be applied multiple times

Returns

The modified input instance for method chaining.

pub fn with_limited_plans(self, plan_codes: Vec<String>) -> Self

Limits the coupon to specific plans.

Arguments

• plan_codes - The plan codes this coupon applies to

Returns

The modified input instance for method chaining.

pub fn with_limited_billable_metrics( self, billable_metric_codes: Vec<String>, ) -> Self

Limits the coupon to specific billable metrics.

Arguments

• billable_metric_codes - The billable metric codes this coupon applies to

Returns

The modified input instance for method chaining.

pub fn with_expiration_at(self, expiration_at: String) -> Self

Sets the expiration timestamp for the coupon (for TimeLimit expiration).

Arguments

• expiration_at - The expiration timestamp (ISO 8601 format)

Returns

The modified input instance for method chaining.

Trait Implementations

impl Clone for CreateCouponInput

fn clone(&self) -> CreateCouponInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCouponInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateCouponInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateCouponInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.