/2.0/subscription/modifiers/create

Create a subscription modifier to dynamically change the subscription payment amount

A modifier applied to a recurring subscription increases or decreases the next payment by a flat amount (in the currency of the subscription). The modifier itself may recur and apply to all future payments until it is removed.

Example Request

curl -X POST -d 'vendor_id=1234567' \
             -d 'vendor_auth_code=123456abc...' \
             -d 'subscription_id=12345' \
             -d 'modifier_recurring=false' \
             -d 'modifier_amount=10.00' \
             -d 'modifier_description=Example Description' \
https://vendors.paddle.com/api/2.0/subscription/modifiers/create

Usage Notes

• To charge the buyer an additional amount, set a positive modifier_amount (e.g. 10). To reduce the buyer’s payment amount, set a negative modifier_amount (e.g. -10).
• Modifiers will not be applied on the immediate payment if the payment is past due, and will only be applied on payments subsequent to the past due payment.
• For VAT-inclusive subscription: the modifier amount will be VAT-deducted first before being added/subtracted from the current subscription balance and VAT-deducted plan price. VAT is only added onto the final amount if the buyer is charged. For example, if a modifier of $10 is additionally charged on a $40 monthly plan with a buyer VAT rate of 20% and a credit balance of $5, the final charge would be: (-$5 + ($40/1.2) + ($10/1.2)) * 1.2 = $44
• For VAT-exclusive subscription: the modifier amount will be added/subtracted from the current subscription balance and plan price. VAT is only added onto the final amount if the buyer is charged. For example, if a modifier of $10 is additionally charged on a $40 monthly plan with a buyer VAT rate of 20% and a credit balance of $5, the final charge would be: (-$5 + $40 + $10) * 1.2 = $54