Enum ProrationBillingMode

#[non_exhaustive]
pub enum ProrationBillingMode {
    ProratedImmediately,
    ProratedNextBillingPeriod,
    FullImmediately,
    FullNextBillingPeriod,
    DoNotBill,
}

How Paddle should handle proration calculation for changes made to a subscription or its items. Required when making changes that impact billing.

For automatically-collected subscriptions, responses may take longer than usual if a proration billing mode that collects for payment immediately is used.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ProratedImmediately

Paddle calculates the prorated amount for the subscription changes based on the current billing cycle, then creates a transaction to collect immediately.

ProratedNextBillingPeriod

Paddle calculates the prorated amount for the subscription changes based on the current billing cycle, then schedules them to be billed on the next renewal.

FullImmediately

Paddle does not calculate proration for the subscription changes, creating a transaction to collect for the full amount immediately.

FullNextBillingPeriod

Paddle does not calculate proration for the subscription changes, scheduling for the full amount for the changes to be billed on the next renewal.

DoNotBill

Paddle does not bill for the subscription changes.

Trait Implementations

impl Clone for ProrationBillingMode

fn clone(&self) -> ProrationBillingMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProrationBillingMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProrationBillingMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProrationBillingMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProrationBillingMode

fn cmp(&self, other: &ProrationBillingMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProrationBillingMode

fn eq(&self, other: &ProrationBillingMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ProrationBillingMode

fn partial_cmp(&self, other: &ProrationBillingMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ProrationBillingMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProrationBillingMode

impl StructuralPartialEq for ProrationBillingMode