Update a Customer-Set Price Link

Overview

Send a PATCH request to update a customer-set price payment link. The same endpoint (PATCH /ipl/v2/payment-links/{id}) is used for all link types; the linkType field value determines which update behavior applies. A customer-set price link uses linkType: DONATION, which lets the buyer enter their own payment amount. To update a fixed-price link, see Update a Fixed-Price Link.

When sending an update request, include all of the fields from the original request to create the link. If you exclude a field, the information corresponding to that field is removed from the updated payment page.

Status-only updates (deactivating or reactivating a link) are a permitted exception — you can send only the status field without including the other link fields.

Sending the Request

Endpoint: PATCH /ipl/v2/payment-links/{id}

For environment base URLs, see Endpoints: Pay by Link.

Set {id} to the payment number ID contained in the create payment link response.

Required Fields

Optional Fields

Example

Production:

PATCH /ipl/v2/payment-links/{id}

Test:

PATCH /ipl/v2/payment-links/{id}

{    "processingInformation": {        "linkType": "DONATION"    },    "orderInformation": {        "amountDetails": {            "minAmount": "1",            "currency": "USD",            "totalAmount": "5"        },        "lineItems": [            {                "productName": "Fundraiser",                "unitPrice": "5"            }        ]    }}

{  "_links": {    "self": {      "href": "/ipl/v2/payment-links/78759658968978",      "method": "GET"    },    "update": {      "href": "/ipl/v2/payment-links/78759658968978",      "method": "PATCH"    }  },  "id": "78759658968978",  "submitTimeUtc": "2024-08-15T21:11:46.163224519Z",  "status": "ACTIVE",  "processingInformation": {    "linkType": "DONATION",    "requestPhone": false,    "requestShipping": false  },  "purchaseInformation": {    "purchaseNumber": "78759658968978",    "createdDate": "2024-08-15T21:08:24.593",    "paymentLink": "/ebc2/payByLink/pay/e1PxwGdhJWtz3MBXCE7DvuXoYlT7G0I2kyb3gRrQY6bLWbH5769guEPlUri2z7Kc"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 5,      "currency": "USD"    },    "lineItems": [      {        "productName": "Fundraiser",        "unitPrice": 5,        "quantity": 1      }    ]  }}

Deactivate a Payment Link

You can deactivate a payment link to no longer allow your customers to use the link. To do this, include the status field in your update request and set it to INACTIVE. If you want to activate the payment link again, you can send your update request with the status field set to ACTIVE.

Production:

PATCH /ipl/v2/payment-links/{id}

Test:

PATCH /ipl/v2/payment-links/{id}

{  "status": "INACTIVE"}

Response

A successful response returns HTTP 200 with the updated payment link details. The response shape matches the create payment link response — see Create a Customer-Set Price Link for field descriptions.

Common error responses:

• 400 — A required field is missing, a field value is invalid, or minAmount exceeds totalAmount.
• 401 — Authentication failed. Verify your credentials.
• 404 — No payment link found for the specified {id}.