pub struct CreateQuoteSubscriptionData {
pub billing_mode: Option<CreateQuoteSubscriptionDataBillingMode>,
pub description: Option<String>,
pub effective_date: Option<CreateQuoteSubscriptionDataEffectiveDate>,
pub metadata: Option<HashMap<String, String>>,
pub trial_period_days: Option<u32>,
}
Expand description
When creating a subscription or subscription schedule, the specified configuration data will be used.
There must be at least one line item with a recurring price for a subscription or subscription schedule to be created.
A subscription schedule is created if subscription_data[effective_date]
is present and in the future, otherwise a subscription is created.
Fields§
§billing_mode: Option<CreateQuoteSubscriptionDataBillingMode>
Controls how prorations and invoices for subscriptions are calculated and orchestrated.
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 Stripe surfaces and certain local payment methods UIs.
effective_date: Option<CreateQuoteSubscriptionDataEffectiveDate>
When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
The effective_date
is ignored if it is in the past when the quote is accepted.
metadata: Option<HashMap<String, String>>
Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted.
If a recurring price is included in line_items
, this field will be passed to the resulting subscription’s metadata
field.
If subscription_data.effective_date
is used, this field will be passed to the resulting subscription schedule’s phases.metadata
field.
Unlike object-level metadata, this field is declarative.
Updates will clear prior values.
trial_period_days: Option<u32>
Integer representing the number of trial period days before the customer is charged for the first time.
Implementations§
Trait Implementations§
Source§impl Clone for CreateQuoteSubscriptionData
impl Clone for CreateQuoteSubscriptionData
Source§fn clone(&self) -> CreateQuoteSubscriptionData
fn clone(&self) -> CreateQuoteSubscriptionData
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more