Struct SubscriptionSchedulePhaseConfiguration

pub struct SubscriptionSchedulePhaseConfiguration {

    pub add_invoice_items: Vec<SubscriptionScheduleAddInvoiceItem>,
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: Option<SchedulesPhaseAutomaticTax>,
    pub billing_cycle_anchor: Option<SubscriptionSchedulePhaseConfigurationBillingCycleAnchor>,
    pub collection_method: Option<SubscriptionSchedulePhaseConfigurationCollectionMethod>,
    pub currency: Currency,
    pub default_payment_method: Option<Expandable<PaymentMethod>>,
    pub default_tax_rates: Option<Vec<TaxRate>>,
    pub description: Option<String>,
    pub discounts: Vec<DiscountsResourceStackableDiscount>,
    pub end_date: Timestamp,
    pub invoice_settings: Option<InvoiceSettingSubscriptionSchedulePhaseSetting>,
    pub items: Vec<SubscriptionScheduleConfigurationItem>,
    pub metadata: Option<HashMap<String, String>>,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub proration_behavior: SubscriptionSchedulePhaseConfigurationProrationBehavior,
    pub start_date: Timestamp,
    pub transfer_data: Option<SubscriptionTransferData>,
    pub trial_end: Option<Timestamp>,
}

A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.

Fields

add_invoice_items: Vec<SubscriptionScheduleAddInvoiceItem>

A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.

application_fee_percent: Option<f64>

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account during this phase of the schedule.

automatic_tax: Option<SchedulesPhaseAutomaticTax>

billing_cycle_anchor: Option<SubscriptionSchedulePhaseConfigurationBillingCycleAnchor>

Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

collection_method: Option<SubscriptionSchedulePhaseConfigurationCollectionMethod>

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.

currency: Currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

default_payment_method: Option<Expandable<PaymentMethod>>

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings.

default_tax_rates: Option<Vec<TaxRate>>

The default tax rates to apply to the subscription during this phase of the subscription schedule.

description: Option<String>

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

discounts: Vec<DiscountsResourceStackableDiscount>

The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.

end_date: Timestamp

The end of this phase of the subscription schedule.

invoice_settings: Option<InvoiceSettingSubscriptionSchedulePhaseSetting>

The invoice settings applicable during this phase.

items: Vec<SubscriptionScheduleConfigurationItem>

Subscription items to configure the subscription to during this phase of the subscription schedule.

metadata: Option<HashMap<String, String>>

Set of key-value pairs that you can attach to a phase. Metadata on a schedule’s phase will update the underlying subscription’s metadata when the phase is entered. Updating the underlying subscription’s metadata directly will not affect the current phase’s metadata.

on_behalf_of: Option<Expandable<Account>>

The account (if any) the charge was made on behalf of for charges associated with the schedule’s subscription. See the Connect documentation for details.

proration_behavior: SubscriptionSchedulePhaseConfigurationProrationBehavior

If the subscription schedule will prorate when transitioning to this phase. Possible values are create_prorations and none.

start_date: Timestamp

The start of this phase of the subscription schedule.

transfer_data: Option<SubscriptionTransferData>

The account (if any) the associated subscription’s payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription’s invoices.

trial_end: Option<Timestamp>

When the trial ends within the phase.

Trait Implementations

impl Clone for SubscriptionSchedulePhaseConfiguration

fn clone(&self) -> SubscriptionSchedulePhaseConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionSchedulePhaseConfiguration

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

Formats the value using the given formatter.

impl Deserialize for SubscriptionSchedulePhaseConfiguration

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for SubscriptionSchedulePhaseConfiguration

fn from_value(v: Value) -> Option<Self>

impl ObjectDeser for SubscriptionSchedulePhaseConfiguration

type Builder = SubscriptionSchedulePhaseConfigurationBuilder