Upgrades & Downgrades

Moves the specified subscription to a new plan.

API Endpoint

The endpoint for the upgrades/downgrades API is: https://vendors.paddle.com/api/2.0/subscription/users/move

Send all field as POST to the API endpoint. A list of accepted fields and their meanings is below.

Field Type Required Default Description
vendor_id Integer Yes - Your Paddle Vendor/Account ID
vendor_auth_code String Yes - Your Paddle code/token for authenticating with the API
subscription_id Integer Yes - The ID of the subscription that you want to upgrade or downgrade
plan_id Integer Yes - The ID of the plan to upgrade or downgrade to
keep_modifiers Boolean No true Whether to retain the modifiers on the subscription. By default we retain them, but you can specify this field as false to clear all modifiers
prorate Boolean No true Whether to charge your customer a pro-rata amount. Specifying this field as false will charge the customer the price of the new plan.
bill_immediately Boolean No true if the plan has a different billing interval and false if the plan has the same billing interval Whether to bill the customer immediately on upgrade or downgrade. If this field is specified as false, then any due credit will be charged on the next invoice.

Note that plans with a different billing interval must be billed immediately.

Example Request


curl -X POST -d 'vendor_id=123' \
             -d 'vendor_auth_code=1:54229abfcfa...' \
             -d 'subscription_id=12345' \
             -d 'plan_id=496307' \
             https://vendors.paddle.com/api/2.0/subscription/users/move

Example Response


{
    "success": true,
    "response": {
        "subscription_id": 2686,
        "user_id": 285846,
        "plan_id": 496199,
        "next_payment": {
            "amount": 10,
            "currency": "USD",
            "date": "2015-11-06"
        }
    }
}
Was this page helpful?