Struct stripe::CreateSubscription [−][src]
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 first invoice for this subscription.
You may pass up to 10 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 subtotal 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.
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 to anchor the subscription's billing cycle.
This is used to determine the date of the first full invoice, and, for plans with month
or year
intervals, the day of the month for subsequent invoices.
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.
Defaults to charge_automatically
.
coupon: Option<CouponId>
The code of the coupon to apply to this subscription.
A coupon applied to a subscription will only affect invoices created for that particular subscription.
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.
expand: &'a [&'a str]
Specifies which fields in the response should be expanded.
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.
payment_behavior: Option<SubscriptionPaymentBehavior>
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 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.
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
.
Valid values are create_prorations
or none
. Passing create_prorations
will cause proration invoice items to be created when applicable.
Prorations can be disabled by passing none
.
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.
This will always overwrite any trials that might apply via a subscribed plan.
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
.
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.
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.
Implementations
impl<'a> CreateSubscription<'a>
[src]
pub fn new(customer: CustomerId) -> Self
[src]
Trait Implementations
impl<'a> Clone for CreateSubscription<'a>
[src]
fn clone(&self) -> CreateSubscription<'a>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Debug for CreateSubscription<'a>
[src]
impl<'a> Serialize for CreateSubscription<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateSubscription<'a>
[src]
impl<'a> Send for CreateSubscription<'a>
[src]
impl<'a> Sync for CreateSubscription<'a>
[src]
impl<'a> Unpin for CreateSubscription<'a>
[src]
impl<'a> UnwindSafe for CreateSubscription<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,