Revise plan or quantity of subscription

POST {{base_url}}/v1/billing/subscriptions/:subscription_id/revise

Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount , shipping_address values for the subscription. This type of update requires the buyer's consent.

Request Body

{&quot;plan_id&quot;=&gt;&quot;{{billing_plan_id}}&quot;, &quot;shipping_amount&quot;=&gt;{&quot;currency_code&quot;=&gt;&quot;USD&quot;, &quot;value&quot;=&gt;&quot;10.00&quot;}, &quot;shipping_address&quot;=&gt;{&quot;name&quot;=&gt;{&quot;full_name&quot;=&gt;&quot;John Doe&quot;}, &quot;address&quot;=&gt;{&quot;address_line_1&quot;=&gt;&quot;2211 N First Street&quot;, &quot;address_line_2&quot;=&gt;&quot;Building 17&quot;, &quot;admin_area_2&quot;=&gt;&quot;San Jose&quot;, &quot;admin_area_1&quot;=&gt;&quot;CA&quot;, &quot;postal_code&quot;=&gt;&quot;95131&quot;, &quot;country_code&quot;=&gt;&quot;US&quot;}}, &quot;application_context&quot;=&gt;{&quot;brand_name&quot;=&gt;&quot;walmart&quot;, &quot;locale&quot;=&gt;&quot;en-US&quot;, &quot;shipping_preference&quot;=&gt;&quot;SET_PROVIDED_ADDRESS&quot;, &quot;payment_method&quot;=&gt;{&quot;payer_selected&quot;=&gt;&quot;PAYPAL&quot;, &quot;payee_preferred&quot;=&gt;&quot;IMMEDIATE_PAYMENT_REQUIRED&quot;}, &quot;return_url&quot;=&gt;&quot;https://example.com/returnUrl&quot;, &quot;cancel_url&quot;=&gt;&quot;https://example.com/cancelUrl&quot;}}

HEADERS

RESPONSES

status: OK

{&quot;plan_id&quot;:&quot;P-39H27838NY539662TMIBPJBA&quot;,&quot;shipping_amount&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;10.0&quot;},&quot;shipping_address&quot;:{&quot;name&quot;:{&quot;full_name&quot;:&quot;John Doe&quot;},&quot;address&quot;:{&quot;address_line_1&quot;:&quot;2211 N First Street&quot;,&quot;address_line_2&quot;:&quot;Building 17&quot;,&quot;admin_area_2&quot;:&quot;San Jose&quot;,&quot;admin_area_1&quot;:&quot;CA&quot;,&quot;postal_code&quot;:&quot;95131&quot;,&quot;country_code&quot;:&quot;US&quot;}},&quot;plan_overridden&quot;:false,&quot;links&quot;:[{&quot;href&quot;:&quot;https://www.sandbox.paypal.com/webapps/billing/subscriptions/update?ba_token=BA-0D497368A6995050E&quot;,&quot;rel&quot;:&quot;approve&quot;,&quot;method&quot;:&quot;GET&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ&quot;,&quot;rel&quot;:&quot;edit&quot;,&quot;method&quot;:&quot;PATCH&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;GET&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/cancel&quot;,&quot;rel&quot;:&quot;cancel&quot;,&quot;method&quot;:&quot;POST&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/suspend&quot;,&quot;rel&quot;:&quot;suspend&quot;,&quot;method&quot;:&quot;POST&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/capture&quot;,&quot;rel&quot;:&quot;capture&quot;,&quot;method&quot;:&quot;POST&quot;}]}