Updating Subscriptions

Updating user subscriptions


Update the subscription and/or quantity for users’ subscriptions.

Field Description
vendor_id Your vendor ID.
vendor_auth_code Your vendor auth code.
subscription_id The ID of the subscription you’re updating.
quantity (Required) The new quantity to be applied to a quantity enabled subscription.
recurring_price (Optional) The new recurring price per unit to apply to a quantity enabled subscription. Please note this is a singular price, i.e 11.00.
currency (Optional, but required if setting recurring_price) The currency that the recurring price should be charged in. E.g. USD,GBP, EUR, etc.
bill_immediately (Optional , defaults to false) If the subscription should bill for the next interval at the revised figures immediately.
plan_id (Optional) The new plan ID to move the subscription to.
prorate (Optional, defaults to true) Whether the change in subscription should be prorated.
keep_modifiers (Optional, defaults to true) Retain the existimg modifiers on the user subscription.


Curl and JSON payload example of a request to update the quantity and price for the user subscription 12345 to 7 and $11.

curl -X POST \
  -d 'vendor_id=123' \
  -d 'vendor_auth_code=456bd...' \
  -d 'subscription_id=12345' \
  -d 'quantity=7' \
  -d 'recurring_price=11.00' \
  -d 'currency=USD' \

   "quantity" : "7",
   "vendor_auth_code" : "456bd...",
   "vendor_id" : "123",
   "recurring_price" : 11,
   "currency" : "USD",
   "subscription_id" : "12345"

Example Response

    "success": true,
    "response": {
        "subscription_id": 12345,
        "user_id": 425123,
        "plan_id": 525123,
        "next_payment": {
            "amount": 144.06,
            "currency": "GBP",
            "date": "2018-02-15"

Please see List Users to get the list of subscribed users.

Failed Response Example

If you try to update the quantity of a non-quantity subscription you will get the following error code.

  "success": false,
  "error": {
  "code": 173,
  "message": "The subscription does not allow quantities to be set."