Struct stripe::UpdateSubscriptionSchedule

pub struct UpdateSubscriptionSchedule<'a> {
    pub default_settings: Option<SubscriptionScheduleDefaultSettingsParams>,
    pub end_behavior: Option<SubscriptionScheduleEndBehavior>,
    pub expand: &'a [&'a str],
    pub metadata: Option<Metadata>,
    pub phases: Option<Vec<UpdateSubscriptionSchedulePhases>>,
    pub proration_behavior: Option<SubscriptionProrationBehavior>,
}

The parameters for SubscriptionSchedule::update.

Fields

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.

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

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. Note that past phases can be omitted.

proration_behavior: Option<SubscriptionProrationBehavior>

If the update changes the current phase, indicates whether the changes should be prorated.

The default value is create_prorations.

Implementations

impl<'a> UpdateSubscriptionSchedule<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdateSubscriptionSchedule<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateSubscriptionSchedule<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UpdateSubscriptionSchedule<'a>

fn default() -> UpdateSubscriptionSchedule<'a>

Returns the “default value” for a type.

impl<'a> Serialize for UpdateSubscriptionSchedule<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.