Struct CreatePlanInput 

pub struct CreatePlanInput {

    pub name: String,
    pub code: String,
    pub interval: PlanInterval,
    pub amount_cents: i64,
    pub amount_currency: String,
    pub invoice_display_name: Option<String>,
    pub description: Option<String>,
    pub trial_period: Option<f64>,
    pub pay_in_advance: Option<bool>,
    pub bill_charges_monthly: Option<bool>,
    pub tax_codes: Option<Vec<String>>,
    pub charges: Option<Vec<CreatePlanChargeInput>>,
    pub minimum_commitment: Option<CreateMinimumCommitmentInput>,
    pub usage_thresholds: Option<Vec<CreateUsageThresholdInput>>,
}

Input data for creating a plan.

Fields

name: String

Name of the plan.

code: String

Unique code for the plan.

interval: PlanInterval

Billing interval.

amount_cents: i64

Base amount in cents.

amount_currency: String

Currency for the amount.

invoice_display_name: Option<String>

Display name for invoices.

description: Option<String>

Description of the plan.

trial_period: Option<f64>

Trial period in days.

pay_in_advance: Option<bool>

Whether the plan is billed in advance.

bill_charges_monthly: Option<bool>

Whether charges are billed monthly for yearly plans.

tax_codes: Option<Vec<String>>

Tax codes for this plan.

charges: Option<Vec<CreatePlanChargeInput>>

Charges for this plan.

minimum_commitment: Option<CreateMinimumCommitmentInput>

Minimum commitment for this plan.

usage_thresholds: Option<Vec<CreateUsageThresholdInput>>

Usage thresholds for progressive billing.

Implementations

impl CreatePlanInput

pub fn new( name: String, code: String, interval: PlanInterval, amount_cents: i64, amount_currency: String, ) -> Self

Creates a new plan input with required fields.

pub fn with_invoice_display_name(self, name: String) -> Self

Sets the invoice display name.

pub fn with_description(self, description: String) -> Self

Sets the description.

pub fn with_trial_period(self, days: f64) -> Self

Sets the trial period in days.

pub fn with_pay_in_advance(self, pay_in_advance: bool) -> Self

Sets whether the plan is billed in advance.

pub fn with_bill_charges_monthly(self, bill_charges_monthly: bool) -> Self

Sets whether charges are billed monthly.

pub fn with_tax_codes(self, tax_codes: Vec<String>) -> Self

Sets the tax codes.

pub fn with_charges(self, charges: Vec<CreatePlanChargeInput>) -> Self

Sets the charges.

pub fn with_minimum_commitment( self, minimum_commitment: CreateMinimumCommitmentInput, ) -> Self

Sets the minimum commitment.

pub fn with_usage_thresholds( self, usage_thresholds: Vec<CreateUsageThresholdInput>, ) -> Self

Sets the usage thresholds.

Trait Implementations

impl Clone for CreatePlanInput

fn clone(&self) -> CreatePlanInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreatePlanInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreatePlanInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreatePlanInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.