Struct stripe::SubscriptionScheduleDefaultSettingsParams

pub struct SubscriptionScheduleDefaultSettingsParams {
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: Option<SubscriptionScheduleDefaultSettingsParamsAutomaticTax>,
    pub billing_cycle_anchor: Option<SubscriptionScheduleDefaultSettingsParamsBillingCycleAnchor>,
    pub billing_thresholds: Option<SubscriptionScheduleBillingThresholds>,
    pub collection_method: Option<CollectionMethod>,
    pub default_payment_method: Option<String>,
    pub description: Option<String>,
    pub invoice_settings: Option<SubscriptionScheduleInvoiceSettings>,
    pub on_behalf_of: Option<String>,
    pub transfer_data: Option<SubscriptionScheduleDefaultSettingsParamsTransferData>,
}

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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.

automatic_tax: Option<SubscriptionScheduleDefaultSettingsParamsAutomaticTax>

Default settings for automatic tax computation.

billing_cycle_anchor: Option<SubscriptionScheduleDefaultSettingsParamsBillingCycleAnchor>

Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed.

Cannot be set to phase_start if this phase specifies a trial. For more information, see the billing cycle documentation.

billing_thresholds: Option<SubscriptionScheduleBillingThresholds>

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

Pass an empty string to remove previously-defined thresholds.

collection_method: Option<CollectionMethod>

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. Defaults to charge_automatically on creation.

default_payment_method: Option<String>

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.

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: Option<SubscriptionScheduleInvoiceSettings>

All invoices will be billed using the specified settings.

on_behalf_of: Option<String>

The account on behalf of which to charge, for each of the associated subscription’s invoices.

transfer_data: Option<SubscriptionScheduleDefaultSettingsParamsTransferData>

The data with which to automatically create a Transfer for each of the associated subscription’s invoices.

Trait Implementations

impl Clone for SubscriptionScheduleDefaultSettingsParams

fn clone(&self) -> SubscriptionScheduleDefaultSettingsParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionScheduleDefaultSettingsParams

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

Formats the value using the given formatter.

impl Default for SubscriptionScheduleDefaultSettingsParams

fn default() -> SubscriptionScheduleDefaultSettingsParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionScheduleDefaultSettingsParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SubscriptionScheduleDefaultSettingsParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.