Replace a payment resource

Replaces all editable fields of an existing payment resource. Use this for full updates.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication.

In: header

Scope: https://uri.paypal.com/services/checkout/payment-resources

Header Parameters

Content-TypestringOptional

The media type. Required for operations with a request body. The value is `application/`, where `format` is `json`.

Match^[A-Za-z0-9/+-]+$Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

integration_modeenum<integration_mode>Required

Determines how the payment resource is presented to customers. Currently, only LINK is supported, which generates a PayPal-hosted payment page with a shareable URL. This value is immutable after creation.

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"LINK"

typeenum<payment_resource_type>Required

The type of payment resource. Once a payment resource is created, this field cannot be changed.

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"BUY_NOW"

reusableenum<reusable>Optional

Indicates if the payment resource can be used multiple times or only once.

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"MULTIPLE"Default

return_urlstringOptional

URL to which the customer is redirected after completing the transaction.

Match^.*$FormaturiLength1 <= length <= 1024

line_itemsobject<line_item>[]Optional

List of individual item in payment resource.

Items1 <= length <= 20

line_item properties

10 properties

namestringOptional

The product or service name displayed to customers during checkout.

Match^.*$Length1 <= length <= 127

product_idstringOptional

Your internal identifier for this product.

Match^.*$Length1 <= length <= 50

descriptionstringOptional

Detailed information about the product or service shown to customers during checkout. Use this to provide additional context, specifications, or terms.

Match^.*$Length1 <= length <= 2048

unit_amountobject<money>Optional

The price per unit of this item, including the numeric value and currency code.

taxesobject<tax>[]Optional

Taxes applied to this item. Tax is displayed separately to customers during checkout.

Items1 <= length <= 1

shippingobject<shipping>[]Optional

Shipping fee for this item. Shipping fee is displayed separately to customers during checkout.

Items1 <= length <= 1

collect_shipping_addressbooleanOptional

Prompts customers for a shipping address during checkout for this item. Set to true for physical goods that require delivery, false for digital goods.

customer_notesobject<customer_note>[]Optional

Label for a custom field to collect additional information from customers about this item (e.g., "Engraving text" or "Special instructions"). Can be set as mandatory.

Items1 <= length <= 1

variantsobject<variants>Optional

Product variants such as size, color, or material presented to customers during checkout. Each variant (e.g., "Size") can have up to 10 options (e.g., "S", "M", "L", "XL"). Supports up to 5 variants total. One variant can be designated as primary to enable different prices per option.

adjustable_quantityobject<adjustable_quantity>Optional

Allows customers to change the quantity of this item during checkout.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/checkout/payment-resources/string" \  -H "Content-Type: application/json" \  -d '{    "integration_mode": "LINK",    "type": "BUY_NOW"  }'

Empty

Header Parameters

Content-TypestringOptional

The media type. Required for operations with a request body. The value is `application/`, where `format` is `json`.

Match^[A-Za-z0-9/+-]+$Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

integration_modeenum<integration_mode>Required

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"LINK"

typeenum<payment_resource_type>Required

The type of payment resource. Once a payment resource is created, this field cannot be changed.

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"BUY_NOW"

reusableenum<reusable>Optional

Indicates if the payment resource can be used multiple times or only once.

Match^[A-Z0-9_]+$Length1 <= length <= 20

Allowed values

"MULTIPLE"Default

return_urlstringOptional

URL to which the customer is redirected after completing the transaction.

Match^.*$FormaturiLength1 <= length <= 1024

line_itemsobject<line_item>[]Optional

List of individual item in payment resource.

Items1 <= length <= 20

line_item properties

10 properties

namestringOptional

The product or service name displayed to customers during checkout.

Match^.*$Length1 <= length <= 127

product_idstringOptional

Your internal identifier for this product.

Match^.*$Length1 <= length <= 50

descriptionstringOptional

Detailed information about the product or service shown to customers during checkout. Use this to provide additional context, specifications, or terms.

Match^.*$Length1 <= length <= 2048

unit_amountobject<money>Optional

The price per unit of this item, including the numeric value and currency code.

taxesobject<tax>[]Optional

Taxes applied to this item. Tax is displayed separately to customers during checkout.

Items1 <= length <= 1

shippingobject<shipping>[]Optional

Shipping fee for this item. Shipping fee is displayed separately to customers during checkout.

Items1 <= length <= 1

collect_shipping_addressbooleanOptional

Prompts customers for a shipping address during checkout for this item. Set to true for physical goods that require delivery, false for digital goods.

customer_notesobject<customer_note>[]Optional

Label for a custom field to collect additional information from customers about this item (e.g., "Engraving text" or "Special instructions"). Can be set as mandatory.

Items1 <= length <= 1

variantsobject<variants>Optional

adjustable_quantityobject<adjustable_quantity>Optional

Allows customers to change the quantity of this item during checkout.

line_item properties

money properties

tax properties

shipping properties

customer_note properties

variants properties

dimension properties

dimension_option properties

money properties

adjustable_quantity properties

204

400application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Replace a payment resource

line_item properties

money properties

tax properties

shipping properties

customer_note properties

variants properties

dimension properties

dimension_option properties

money properties

adjustable_quantity properties

204

400application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`