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 copy 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 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.