- Authorization
- Orders
- Payments
- Invoices
- Subscriptions
- Catalog Products
- Plans
- Subscriptions
- Payouts
- Webhooks
- Shipment Tracking
- Transaction Search
- Disputes
- List disputes
- Show dispute details
- Accept claim
- Appeal dispute
- Settle dispute
- Update dispute status
- Make offer to resolve dispute
- Provide evidence
- Acknowledge returned item
- Provide supporting information for dispute
- Escalate dispute to claim
- Accept offer to resolve dispute
- Send message about dispute to other party
- Deny offer to resolve dispute
- Partially update dispute
- Onboarding (Limited Release)
Revise plan or quantity of subscription
POST
/v1/billing/subscriptions/{subscription_id}/revise
shipping_amount, shipping_address values for the subscription. This type of update requires the buyer's consent.请求参数
Authorization
在 Header 添加参数
Authorization
，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password示例：
Authorization: Basic *****************Path 参数
subscription_id
string
必需
示例值:
{{subscription_id}}
Header 参数
Content-Type
string
必需
示例值:
application/json
Body 参数application/json
plan_id
string
必需
shipping_amount
object
必需
currency_code
string
必需
value
string
必需
shipping_address
object
必需
name
object
必需
address
object
必需
application_context
object
必需
brand_name
string
必需
locale
string
必需
shipping_preference
string
必需
payment_method
object
必需
return_url
string
必需
cancel_url
string
必需
示例
{
"plan_id": "{{billing_plan_id}}",
"shipping_amount": {
"currency_code": "USD",
"value": "10.00"
},
"shipping_address": {
"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"
}
},
"application_context": {
"brand_name": "walmart",
"locale": "en-US",
"shipping_preference": "SET_PROVIDED_ADDRESS",
"payment_method": {
"payer_selected": "PAYPAL",
"payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
},
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v1/billing/subscriptions/{{subscription_id}}/revise' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
"plan_id": "{{billing_plan_id}}",
"shipping_amount": {
"currency_code": "USD",
"value": "10.00"
},
"shipping_address": {
"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"
}
},
"application_context": {
"brand_name": "walmart",
"locale": "en-US",
"shipping_preference": "SET_PROVIDED_ADDRESS",
"payment_method": {
"payer_selected": "PAYPAL",
"payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
},
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}'返回响应
🟢200200 - Revise Plan Or Quantity Of Subscription
application/json
Body
plan_id
string
必需
shipping_amount
object
必需
currency_code
string
必需
value
string
必需
shipping_address
object
必需
name
object
必需
address
object
必需
plan_overridden
boolean
必需
links
array [object {3}]
必需
href
string
必需
rel
string
必需
method
string
必需
示例
{
"plan_id": "P-39H27838NY539662TMIBPJBA",
"shipping_amount": {
"currency_code": "USD",
"value": "10.0"
},
"shipping_address": {
"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"
}
},
"plan_overridden": false,
"links": [
{
"href": "https://www.sandbox.paypal.com/webapps/billing/subscriptions/update?ba_token=BA-0D497368A6995050E",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ",
"rel": "self",
"method": "GET"
},
{
"href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/cancel",
"rel": "cancel",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/suspend",
"rel": "suspend",
"method": "POST"
},
{
"href": "https://api.sandbox.paypal.com/v1/billing/subscriptions/I-00YGWV5XH5SJ/capture",
"rel": "capture",
"method": "POST"
}
]
}🟠401401 Unauthorized - Invalid Token
🟠404404 Not Found - Subscription Not Found
🟠422422 Unprocessable Entity - Invalid Subscription Status
🟠422422 Unprocessable Entity - Payment In Progress