Struct stripe::UpdateSubscriptionSchedule
source · 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>,
}
Expand description
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§
source§impl<'a> UpdateSubscriptionSchedule<'a>
impl<'a> UpdateSubscriptionSchedule<'a>
Trait Implementations§
source§impl<'a> Clone for UpdateSubscriptionSchedule<'a>
impl<'a> Clone for UpdateSubscriptionSchedule<'a>
source§fn clone(&self) -> UpdateSubscriptionSchedule<'a>
fn clone(&self) -> UpdateSubscriptionSchedule<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more