Update subscription

Updates a subscription which could be in ACTIVE or SUSPENDED status. You can override plan level default attributes by providing customised values for plan path in the patch request.

You cannot update attributes that have already completed (Example - trial cycles can’t be updated if completed).
Once overridden, changes to plan resource will not impact subscription.
Any price update will not impact billing cycles within next 10 days (Applicable only for subscriptions funded by PayPal account).

Following are the fields eligible for patch.

Attribute or object	Operations
`billing_info.outstanding_balance`	replace
`custom_id`	add,replace
`plan.billing_cycles[@sequence==n]. pricing_scheme.fixed_price`	add,replace
`plan.billing_cycles[@sequence==n]. pricing_scheme.tiers`	replace
`plan.billing_cycles[@sequence==n]. total_cycles`	replace
`plan.payment_preferences. auto_bill_outstanding`	replace
`plan.payment_preferences. payment_failure_threshold`	replace
`plan.taxes.inclusive`	add,replace
`plan.taxes.percentage`	add,replace
`shipping_amount`	add,replace
`start_time`	replace
`subscriber.shipping_address`	add,replace
`subscriber.payment_source (for subscriptions funded by card payments)`	replace

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

Header 参数

Body 参数application/json

示例

[
    {
        "op": "replace",
        "path": "/subscriber/shipping_address",
        "value": {
            "name": {
                "full_name": "John Doe"
            },
            "address": {
                "address_line_1": "2211 N First Street",
                "address_line_2": "Building 17",
                "admin_area_2": "San Jose",
                "admin_area_1": "CA",
                "postal_code": "95131",
                "country_code": "US"
            }
        }
    },
    {
        "op": "replace",
        "path": "/plan/payment_preferences/auto_bill_outstanding",
        "value": true
    },
    {
        "op": "replace",
        "path": "/plan/payment_preferences/payment_failure_threshold",
        "value": 1
    },
    {
        "op": "replace",
        "path": "/plan/billing_cycles/@sequence==1/total_cycles",
        "value": 2
    },
    {
        "op": "replace",
        "path": "/plan/billing_cycles/@sequence==1/pricing_scheme/fixed_price",
        "value": {
            "currency_code": "USD",
            "value": "50.00"
        }
    }
]

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

请求参数

请求示例代码

返回响应