Update plan

PATCH

/v1/billing/plans/{billing_plan_id}

Updates a plan with the CREATED or ACTIVE status. For an INACTIVE plan, you can make only status updates.
You can patch these attributes and objects:

Attribute or object	Operations
`description`	replace
`payment_preferences.auto_bill_outstanding`	replace
`taxes.percentage`	replace
`payment_preferences.payment_failure_threshold`	replace
`payment_preferences.setup_fee`	replace
`payment_preferences.setup_fee_failure_action`	replace
`name`	replace

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

billing_plan_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:

string

可选

path

string

可选

value

integer

可选

示例

[
    {
        "op": "replace",
        "path": "/payment_preferences/payment_failure_threshold",
        "value": 7
    }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://api-m.sandbox.paypal.com/v1/billing/plans/{{billing_plan_id}}' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '[
    {
        "op": "replace",
        "path": "/payment_preferences/payment_failure_threshold",
        "value": 7
    }
]'

返回响应

🟢204204 - Update Plan

application/json

Body

object {0}

示例

{}

🟠400400 Bad Request - Invalid Patch Path

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Billing Plan Not Found

修改于 2023-08-16 07:18:59

Show plan details

Deactivate plan