PayPal · Schema

Subscription Modify Plan Request

The request to update 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` and `shipping_address` values for the subscription. This type of update requires the buyer's consent.

BillingCommerceDisputesInvoicesOrderPaymentsPayoutsSubscriptionTokensWebhook

Properties

Name Type Description
plan_id string The unique PayPal-generated ID for the plan.
quantity string The quantity of the product or service in the subscription.
shipping_amount object The shipping charges.
shipping_address object The shipping address of the subscriber.
application_context object
plan object An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not
View JSON Schema on GitHub

JSON Schema

paypal-subscription-revise-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/subscription_revise_request",
  "title": "Subscription Modify Plan Request",
  "description": "The request to update 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` and `shipping_address` values for the subscription. This type of update requires the buyer's consent.",
  "type": "object",
  "properties": {
    "plan_id": {
      "type": "string",
      "description": "The unique PayPal-generated ID for the plan.",
      "minLength": 3,
      "maxLength": 50
    },
    "quantity": {
      "type": "string",
      "description": "The quantity of the product or service in the subscription.",
      "pattern": "^([0-9]+|([0-9]+)?[.][0-9]+)$",
      "minLength": 1,
      "maxLength": 32
    },
    "shipping_amount": {
      "description": "The shipping charges.",
      "$ref": "#/components/schemas/money"
    },
    "shipping_address": {
      "description": "The shipping address of the subscriber.",
      "$ref": "#/components/schemas/shipping_detail"
    },
    "application_context": {
      "$ref": "#/components/schemas/application_context"
    },
    "plan": {
      "description": "An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise.",
      "$ref": "#/components/schemas/plan_override"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/paypal-subscription-revise-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.