ProrationMode enum
Enum representing the proration mode.
When upgrading or downgrading a subscription, set this mode to provide details about the proration that will be applied when the subscription changes.
Wraps BillingFlowParams.ProrationMode
See the linked documentation for an explanation of the different constants.
Constructors
- ProrationMode()
-
const
Values
- unknownSubscriptionUpgradeDowngradePolicy → const ProrationMode
-
Unknown upgrade or downgrade policy.
- immediateWithTimeProration → const ProrationMode
-
Replacement takes effect immediately, and the remaining time will be prorated and credited to the user.
This is the current default behavior.
- immediateAndChargeProratedPrice → const ProrationMode
-
Replacement takes effect immediately, and the billing cycle remains the same.
The price for the remaining period will be charged. This option is only available for subscription upgrade.
- immediateWithoutProration → const ProrationMode
-
Replacement takes effect immediately, and the new price will be charged on next recurrence time.
The billing cycle stays the same.
- deferred → const ProrationMode
-
Replacement takes effect when the old plan expires, and the new price will be charged at the same time.
- immediateAndChargeFullPrice → const ProrationMode
-
Replacement takes effect immediately, and the user is charged full price of new plan and is given a full billing cycle of subscription, plus remaining prorated time from the old plan.
Properties
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
ProrationMode> - A constant List of the values in this enum, in order of their declaration.