Struct stripe::CreateSubscriptionSchedule

pub struct CreateSubscriptionSchedule<'a> {
    pub customer: Option<CustomerId>,
    pub default_settings: Option<SubscriptionScheduleDefaultSettingsParams>,
    pub end_behavior: Option<SubscriptionScheduleEndBehavior>,
    pub expand: &'a [&'a str],
    pub from_subscription: Option<&'a str>,
    pub metadata: Option<Metadata>,
    pub phases: Option<Vec<CreateSubscriptionSchedulePhases>>,
    pub start_date: Option<Scheduled>,
}

The parameters for SubscriptionSchedule::create.

Fields

customer: Option<CustomerId>

The identifier of the customer to create the subscription schedule for.

default_settings: Option<SubscriptionScheduleDefaultSettingsParams>

Object representing the subscription schedule’s default settings.

end_behavior: Option<SubscriptionScheduleEndBehavior>

Behavior of the subscription schedule and underlying subscription when it ends.

Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

from_subscription: Option<&'a str>

Migrate an existing subscription to be managed by a subscription schedule.

If this parameter is set, a subscription schedule will be created using the subscription’s item(s), set to auto-renew using the subscription’s interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.

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.

phases: Option<Vec<CreateSubscriptionSchedulePhases>>

List representing phases of the subscription schedule.

Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.

start_date: Option<Scheduled>

When the subscription schedule starts.

We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.

Implementations

impl<'a> CreateSubscriptionSchedule<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for CreateSubscriptionSchedule<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateSubscriptionSchedule<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CreateSubscriptionSchedule<'a>

fn default() -> CreateSubscriptionSchedule<'a>

Returns the “default value” for a type.

impl<'a> Serialize for CreateSubscriptionSchedule<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.