Struct stripe::SubscriptionScheduleDefaultSettings

pub struct SubscriptionScheduleDefaultSettings {
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: Option<SubscriptionSchedulesResourceDefaultSettingsAutomaticTax>,
    pub billing_cycle_anchor: SubscriptionScheduleDefaultSettingsBillingCycleAnchor,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub collection_method: Option<SubscriptionScheduleDefaultSettingsCollectionMethod>,
    pub default_payment_method: Option<Expandable<PaymentMethod>>,
    pub description: Option<String>,
    pub invoice_settings: SubscriptionScheduleInvoiceSettings,
    pub on_behalf_of: Option<Expandable<Account>>,
    pub transfer_data: Option<SubscriptionTransferData>,
}

Fields

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<SubscriptionSchedulesResourceDefaultSettingsAutomaticTax>

billing_cycle_anchor: SubscriptionScheduleDefaultSettingsBillingCycleAnchor

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.

billing_thresholds: Option<SubscriptionBillingThresholds>

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

collection_method: Option<SubscriptionScheduleDefaultSettingsCollectionMethod>

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.

default_payment_method: Option<Expandable<PaymentMethod>>

ID of the default payment method for the subscription schedule.

If not set, invoices will use the default payment method in the customer’s invoice settings.

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.

invoice_settings: SubscriptionScheduleInvoiceSettings

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.

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.

Trait Implementations

impl Clone for SubscriptionScheduleDefaultSettings

fn clone(&self) -> SubscriptionScheduleDefaultSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionScheduleDefaultSettings

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

Formats the value using the given formatter.

impl Default for SubscriptionScheduleDefaultSettings

fn default() -> SubscriptionScheduleDefaultSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionScheduleDefaultSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SubscriptionScheduleDefaultSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.