Struct stripe::CreateSubscription

pub struct CreateSubscription<'a> {

    pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
    pub application_fee_percent: Option<f64>,
    pub automatic_tax: Option<CreateSubscriptionAutomaticTax>,
    pub backdate_start_date: Option<Timestamp>,
    pub billing_cycle_anchor: Option<Timestamp>,
    pub billing_cycle_anchor_config: Option<CreateSubscriptionBillingCycleAnchorConfig>,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub cancel_at: Option<Timestamp>,
    pub cancel_at_period_end: Option<bool>,
    pub collection_method: Option<CollectionMethod>,
    pub coupon: Option<CouponId>,
    pub currency: Option<Currency>,
    pub customer: CustomerId,
    pub days_until_due: Option<u32>,
    pub default_payment_method: Option<&'a str>,
    pub default_source: Option<&'a str>,
    pub default_tax_rates: Option<Vec<String>>,
    pub description: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub invoice_settings: Option<CreateSubscriptionInvoiceSettings>,
    pub items: Option<Vec<CreateSubscriptionItems>>,
    pub metadata: Option<Metadata>,
    pub off_session: Option<bool>,
    pub on_behalf_of: Option<String>,
    pub payment_behavior: Option<SubscriptionPaymentBehavior>,
    pub payment_settings: Option<CreateSubscriptionPaymentSettings>,
    pub pending_invoice_item_interval: Option<CreateSubscriptionPendingInvoiceItemInterval>,
    pub promotion_code: Option<PromotionCodeId>,
    pub proration_behavior: Option<SubscriptionProrationBehavior>,
    pub transfer_data: Option<CreateSubscriptionTransferData>,
    pub trial_end: Option<Scheduled>,
    pub trial_from_plan: Option<bool>,
    pub trial_period_days: Option<u32>,
    pub trial_settings: Option<CreateSubscriptionTrialSettings>,
}

The parameters for Subscription::create.

Fields

add_invoice_items: Option<Vec<AddInvoiceItems>>

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

You may pass up to 20 items.

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

Automatic tax settings for this subscription.

We recommend you only include this parameter when the existing value is being changed.

backdate_start_date: Option<Timestamp>

For new subscriptions, a past timestamp to backdate the subscription’s start date to.

If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

billing_cycle_anchor: Option<Timestamp>

A future timestamp in UTC format to anchor the subscription’s billing cycle.

The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals.

billing_cycle_anchor_config: Option<CreateSubscriptionBillingCycleAnchorConfig>

Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals.

When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.

billing_thresholds: Option<SubscriptionBillingThresholds>

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.

cancel_at: Option<Timestamp>

A timestamp at which the subscription should cancel.

If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.

cancel_at_period_end: Option<bool>

Boolean indicating whether this subscription should cancel at the end of the current period.

collection_method: Option<CollectionMethod>

Either charge_automatically, or send_invoice.

When charging automatically, Stripe will attempt to pay this subscription at the end of the 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.

coupon: Option<CouponId>

The ID of the coupon to apply to this subscription.

A coupon applied to a subscription will only affect invoices created for that particular subscription.

currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: CustomerId

The identifier of the customer to subscribe.

days_until_due: Option<u32>

Number of days a customer has to pay invoices generated by this subscription.

Valid only for subscriptions where collection_method is set to send_invoice.

default_payment_method: Option<&'a str>

ID of the default payment method for the subscription.

It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

default_source: Option<&'a str>

ID of the default payment source for the subscription.

It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

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<&'a str>

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 Stripe surfaces and certain local payment methods UIs.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

invoice_settings: Option<CreateSubscriptionInvoiceSettings>

All invoices will be billed using the specified settings.

items: Option<Vec<CreateSubscriptionItems>>

A list of up to 20 subscription items, each with an attached price.

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.

off_session: Option<bool>

Indicates if a customer is on or off-session while an invoice payment is attempted.

on_behalf_of: Option<String>

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

payment_behavior: Option<SubscriptionPaymentBehavior>

Only applies to subscriptions with collection_method=charge_automatically.

Use allow_incomplete to create subscriptions with status=incomplete if the first invoice cannot be paid.

Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior. Use default_incomplete to create Subscriptions with status=incomplete when the first invoice requires payment, otherwise start as active. Subscriptions transition to status=active when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to status=incomplete_expired, which is a terminal state. Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more. pending_if_incomplete is only used with updates and cannot be passed when creating a subscription. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first invoice status.

payment_settings: Option<CreateSubscriptionPaymentSettings>

Payment settings to pass to invoices created by the subscription.

pending_invoice_item_interval: Option<CreateSubscriptionPendingInvoiceItemInterval>

Specifies an interval for how often to bill for any pending invoice items.

It is analogous to calling Create an invoice for the given subscription at the specified interval.

promotion_code: Option<PromotionCodeId>

The API ID of a promotion code to apply to this subscription.

A promotion code applied to a subscription will only affect invoices created for that particular subscription.

proration_behavior: Option<SubscriptionProrationBehavior>

Determines how to handle prorations resulting from the billing_cycle_anchor.

If no value is passed, the default is create_prorations.

transfer_data: Option<CreateSubscriptionTransferData>

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

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

If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer’s trial immediately. Can be at most two years from billing_cycle_anchor. See Using trial periods on subscriptions to learn more.

trial_from_plan: Option<bool>

Indicates if a plan’s trial_period_days should be applied to the subscription.

Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.

trial_period_days: Option<u32>

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

This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.

trial_settings: Option<CreateSubscriptionTrialSettings>

Settings related to subscription trials.

Implementations

impl<'a> CreateSubscription<'a>

pub fn new(customer: CustomerId) -> Self

Trait Implementations

impl<'a> Clone for CreateSubscription<'a>

fn clone(&self) -> CreateSubscription<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateSubscription<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreateSubscription<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.