Struct CancelSubscriptionSchedule 

pub struct CancelSubscriptionSchedule { /* private fields */ }

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

Implementations

impl CancelSubscriptionSchedule

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

Construct a new CancelSubscriptionSchedule.

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

Specifies which fields in the response should be expanded.

pub fn invoice_now(self, invoice_now: impl Into<bool>) -> Self

If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.

pub fn prorate(self, prorate: impl Into<bool>) -> Self

If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.

impl CancelSubscriptionSchedule

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 CancelSubscriptionSchedule

fn clone(&self) -> CancelSubscriptionSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelSubscriptionSchedule

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

Formats the value using the given formatter.

impl Serialize for CancelSubscriptionSchedule

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 CancelSubscriptionSchedule

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.