Struct SubscriptionPause

pub struct SubscriptionPause<'a> { /* private fields */ }

Request builder for pausing a subscription.

Implementations

impl<'a> SubscriptionPause<'a>

pub fn new( client: &'a Paddle, subscription_id: impl Into<SubscriptionID>, ) -> Self

pub fn effective_from(&mut self, effective_from: EffectiveFrom) -> &mut Self

When this subscription change should take effect from.

Defaults to next_billing_period for active subscriptions, which creates a scheduled_change to apply the subscription change at the end of the billing period.

pub fn resume_at(&mut self, datetime: DateTime<Utc>) -> &mut Self

Datetime of when the paused subscription should resume. Omit to pause indefinitely until resumed.

pub fn on_resume(&mut self, value: SubscriptionOnResume) -> &mut Self

How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.

pub async fn send(&self) -> Result<SuccessResponse<Subscription>, Error>

Send the request to Paddle and return the response.

Trait Implementations

impl<'a> Serialize for SubscriptionPause<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.