Update plan
PATCH {{base_url}}/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 |
Request Body
{"0"=>{"op"=>"replace", "path"=>"/payment_preferences/payment_failure_threshold", "value"=>7}}
HEADERS
| Key | Datatype | Required | Description |
| 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. |
| PayPal-Request-Id | string | | The server stores keys for 72 hours. |
| PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. |
| PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. |
| PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
|
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: ``