Struct UpdateSubscriptionSchedule 

pub struct UpdateSubscriptionSchedule { /* private fields */ }

Updates an existing subscription schedule.

Implementations

impl UpdateSubscriptionSchedule

pub fn new(schedule: impl Into<SubscriptionScheduleId>) -> Self

Construct a new UpdateSubscriptionSchedule.

pub fn default_settings( self, default_settings: impl Into<UpdateSubscriptionScheduleDefaultSettings>, ) -> Self

Object representing the subscription schedule’s default settings.

pub fn end_behavior( self, end_behavior: impl Into<SubscriptionScheduleEndBehavior>, ) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn phases( self, phases: impl Into<Vec<UpdateSubscriptionSchedulePhases>>, ) -> Self

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.

pub fn proration_behavior( self, proration_behavior: impl Into<UpdateSubscriptionScheduleProrationBehavior>, ) -> Self

If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is create_prorations.

impl UpdateSubscriptionSchedule

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for UpdateSubscriptionSchedule

fn clone(&self) -> UpdateSubscriptionSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateSubscriptionSchedule

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

Formats the value using the given formatter.

impl Serialize for UpdateSubscriptionSchedule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for UpdateSubscriptionSchedule

type Output = SubscriptionSchedule

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.