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>
Configures how the subscription schedule behaves 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 if the changes should be prorated.
Possible values are create_prorations
or none
, and the default value is create_prorations
.
Implementations
sourceimpl<'a> UpdateSubscriptionSchedule<'a>
impl<'a> UpdateSubscriptionSchedule<'a>
Trait Implementations
sourceimpl<'a> Clone for UpdateSubscriptionSchedule<'a>
impl<'a> Clone for UpdateSubscriptionSchedule<'a>
sourcefn clone(&self) -> UpdateSubscriptionSchedule<'a>
fn clone(&self) -> UpdateSubscriptionSchedule<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'a> Debug for UpdateSubscriptionSchedule<'a>
impl<'a> Debug for UpdateSubscriptionSchedule<'a>
sourceimpl<'a> Default for UpdateSubscriptionSchedule<'a>
impl<'a> Default for UpdateSubscriptionSchedule<'a>
sourcefn default() -> UpdateSubscriptionSchedule<'a>
fn default() -> UpdateSubscriptionSchedule<'a>
Returns the “default value” for a type. Read more
sourceimpl<'a> Serialize for UpdateSubscriptionSchedule<'a>
impl<'a> Serialize for UpdateSubscriptionSchedule<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for UpdateSubscriptionSchedule<'a>
impl<'a> Send for UpdateSubscriptionSchedule<'a>
impl<'a> Sync for UpdateSubscriptionSchedule<'a>
impl<'a> Unpin for UpdateSubscriptionSchedule<'a>
impl<'a> UnwindSafe for UpdateSubscriptionSchedule<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more