Price Modifiers

Allows you to dynamically change the subscription payment amount (+/-).

Adding Modifiers

Example Request


curl -X POST -d 'vendor_id=123' \
             -d 'vendor_auth_code=1:54229abfcfa...' \
             -d 'subscription_id=12345' \
             -d 'modifier_recurring=false' \
             -d 'modifier_amount=10.00' \
             -d 'modifier_description=Example%20Description' \
             https://vendors.paddle.com/api/2.0/subscription/modifiers/create

Example Response


{
    "success": true,
    "response": {
        "subscription_id": 12345,
        "modifier_id": 10
    }
}

Note: modifiers will not be applied on the immediate payment if the payment is past due. The modifier will only be applied on payments subsequent to the past due payment.

Removing Modifiers

Example Request


curl -X POST -d 'vendor_id=123' \
             -d 'vendor_auth_code=1:54229abfcfa...' \
             -d 'modifier_id=10' \
             https://vendors.paddle.com/api/2.0/subscription/modifiers/delete

Example Response


{
    "success": true
}

List Modifiers

Example Request

List all the modifiers.

Optionally, it accepts the parameter plan_id with the value of a Plan/Product ID, to list all the subscriptions modifiers of a certain plan. It also accepts subscription_id to get modifier information of a specific subscription plan.


curl -X POST -d 'vendor_id=123' \
             -d 'vendor_auth_code=154229abfcfa' \
             -d 'subscription_id=12345' \
             https://vendors.paddle.com/api/2.0/subscription/modifiers

Example Response


{
    "success": true,
    "response": [
        {
            "modifier_id": 10,
            "subscription_id": 12345,
            "amount": "1.000",
            "currency": "USD",
            "is_recurring": false,
            "description": "Example Modifier"
        }
    ]
}

Questions about Paddle?

If you need any help regarding your Paddle integration, please get in touch with our Customer Success team using the form below.