Add ability to update Subscription Items with different proration modes for addition and removal. #246
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a new method
updateItemsWithDifferentProration
to the Subscription model.It allows the consumer of the package to specify the proration mode to be used for adding new items or incrementing the
quantity of existing items already on the subscription, with a separate proration mode than removing items or
decrementing the quantity of existing items.
Why
In non-trivial subscription scenarios, it is sometimes desirable to apply different proration behaviors for addition and
removal of a item on a subscription,
A Specific example of this is the following scenario:
has passed)
In this scenario, the following is expected:
prorated_immediately
on addition of item)the month. (aka
full_next_billing_period
on removal of item)Usage
Etc
The logic could probably be simplified a bit, but i have provided tests for various scenarios so we can refactor it if needed.
Fully understand if this use-case is too niche to put in "core", but it's fairly common practice for B2B SaaS, and is a PITA to implement with Paddle.
(Package does not have pint, so my editor messed with the formatting, assuming this will be auto-fixed by GitHub actions)