Update subscription - Paypal API

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 参数

subscription_id

string

必需

示例值:

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 72 hours.

示例值:

Prefer

string

必需

The preferred server response upon successful completion of the request. Value is:

return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
return=representation. The server returns a complete resource representation, including the current state of the resource.

示例值:

Body 参数application/json

array of:

op

string

必需

path

string

必需

value

object

必需

name

object

可选

address

object

可选

currency_code

string

必需

value

string

必需

示例

[
  {
    "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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request PATCH 'https://api-m.sandbox.paypal.com/v1/billing/subscriptions/{{subscription_id}}' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '[
    {
        "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"
        }
    }
]'

返回响应

🟢204204 - Update Subscription

application/json

Body

object {0}

示例

{}

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Subscription Not Found

🟠422422 Unprocessable Entity - Amount Greater Than Outstanding Balance