Modify Subscription Response

The response to a 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.

Structure

ModifySubscriptionResponse

Fields

Name	Type	Tags	Description	Getter	Setter
PlanId	String	Optional	The unique PayPal-generated ID for the plan. Constraints: Minimum Length: 26, Maximum Length: 26, Pattern: ^P-[A-Z0-9]*$	String getPlanId()	setPlanId(String planId)
Quantity	String	Optional	The quantity of the product or service in the subscription. Constraints: Minimum Length: 1, Maximum Length: 32, Pattern: ^([0-9]+|([0-9]+)?[.][0-9]+)$	String getQuantity()	setQuantity(String quantity)
ShippingAmount	Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	Money getShippingAmount()	setShippingAmount(Money shippingAmount)
ShippingAddress	ShippingDetails	Optional	The shipping details.	ShippingDetails getShippingAddress()	setShippingAddress(ShippingDetails shippingAddress)
Plan	PlanOverride	Optional	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.	PlanOverride getPlan()	setPlan(PlanOverride plan)
PlanOverridden	Boolean	Optional, Read-only	Indicates whether the subscription has overridden any plan attributes.	Boolean getPlanOverridden()	setPlanOverridden(Boolean planOverridden)
Links	List<LinkDescription>	Optional, Read-only	An array of request-related HATEOAS links.	List getLinks()	setLinks(List links)

Example (as JSON)

{
  "plan_id": "plan_id6",
  "quantity": "quantity0",
  "shipping_amount": {
    "currency_code": "currency_code0",
    "value": "value6"
  },
  "shipping_address": {
    "name": {
      "full_name": "full_name6"
    },
    "email_address": "email_address8",
    "phone_number": {
      "country_code": "country_code2",
      "national_number": "national_number6"
    },
    "type": "PICKUP_IN_STORE",
    "options": [
      {
        "id": "id2",
        "label": "label2",
        "type": "SHIPPING",
        "amount": {
          "currency_code": "currency_code6",
          "value": "value0"
        },
        "selected": false
      }
    ]
  },
  "plan": {
    "billing_cycles": [
      {
        "pricing_scheme": {
          "version": 10,
          "fixed_price": {
            "currency_code": "currency_code4",
            "value": "value0"
          },
          "pricing_model": "VOLUME",
          "tiers": [
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            },
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            },
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            }
          ],
          "create_time": "create_time4"
        },
        "sequence": 8,
        "total_cycles": 198
      },
      {
        "pricing_scheme": {
          "version": 10,
          "fixed_price": {
            "currency_code": "currency_code4",
            "value": "value0"
          },
          "pricing_model": "VOLUME",
          "tiers": [
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            },
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            },
            {
              "starting_quantity": "starting_quantity8",
              "ending_quantity": "ending_quantity6",
              "amount": {
                "currency_code": "currency_code6",
                "value": "value0"
              }
            }
          ],
          "create_time": "create_time4"
        },
        "sequence": 8,
        "total_cycles": 198
      }
    ],
    "payment_preferences": {
      "auto_bill_outstanding": false,
      "setup_fee": {
        "currency_code": "currency_code8",
        "value": "value4"
      },
      "setup_fee_failure_action": "CONTINUE",
      "payment_failure_threshold": 104
    },
    "taxes": {
      "percentage": "percentage8",
      "inclusive": false
    }
  }
}