subscriptions

Revise plan or quantity of subscription

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.

post/v1/billing/subscriptions/{id}/revise

Request

Path parameters

idstring required

The ID of the subscription.

Headers

Content-Typestring required

The media type. Required for operations with a request body. The value is application/<format>, where the format is json.

Request body

plan_idstring

The unique PayPal-generated ID for the plan.

quantitystring

The quantity of the product or service in the subscription.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows subscription details.

plan_idstring

The unique PayPal-generated ID for the plan.

quantitystring

The quantity of the product or service in the subscription.

plan_overriddenboolean

Indicates whether the subscription has overridden any plan attributes.

Changes

No recorded changes to this operation across all 1 revision of this API.