Struct stripe::CreateCheckoutSessionSubscriptionData

pub struct CreateCheckoutSessionSubscriptionData {
    pub application_fee_percent: Option<f64>,
    pub billing_cycle_anchor: Option<Timestamp>,
    pub default_tax_rates: Option<Vec<String>>,
    pub description: Option<String>,
    pub invoice_settings: Option<CreateCheckoutSessionSubscriptionDataInvoiceSettings>,
    pub metadata: Option<Metadata>,
    pub on_behalf_of: Option<String>,
    pub proration_behavior: Option<CreateCheckoutSessionSubscriptionDataProrationBehavior>,
    pub transfer_data: Option<CreateCheckoutSessionSubscriptionDataTransferData>,
    pub trial_end: Option<Timestamp>,
    pub trial_period_days: Option<u32>,
    pub trial_settings: Option<CreateCheckoutSessionSubscriptionDataTrialSettings>,
}

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. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

billing_cycle_anchor: Option<Timestamp>

A future timestamp to anchor the subscription’s billing cycle for new subscriptions.

default_tax_rates: Option<Vec<String>>

The tax rates that will apply to any subscription item that does not have tax_rates set.

Invoices created will have their default_tax_rates populated from the subscription.

description: Option<String>

The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the customer portal.

invoice_settings: Option<CreateCheckoutSessionSubscriptionDataInvoiceSettings>

All invoices will be billed using the specified settings.

metadata: Option<Metadata>

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

on_behalf_of: Option<String>

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

proration_behavior: Option<CreateCheckoutSessionSubscriptionDataProrationBehavior>

Determines how to handle prorations resulting from the billing_cycle_anchor.

If no value is passed, the default is create_prorations.

transfer_data: Option<CreateCheckoutSessionSubscriptionDataTransferData>

If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

trial_end: Option<Timestamp>

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.

Has to be at least 48 hours in the future.

trial_period_days: Option<u32>

Integer representing the number of trial period days before the customer is charged for the first time.

Has to be at least 1.

trial_settings: Option<CreateCheckoutSessionSubscriptionDataTrialSettings>

Settings related to subscription trials.

Trait Implementations

impl Clone for CreateCheckoutSessionSubscriptionData

fn clone(&self) -> CreateCheckoutSessionSubscriptionData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCheckoutSessionSubscriptionData

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

Formats the value using the given formatter.

impl Default for CreateCheckoutSessionSubscriptionData

fn default() -> CreateCheckoutSessionSubscriptionData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateCheckoutSessionSubscriptionData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateCheckoutSessionSubscriptionData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.