Update a collections payment promise

Idempotency Supported

Updates an active collections payment promise. You can change promised_on, reason, or promised_by; omitted parameters remain unchanged.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/collections_payment_promises/{collections-payment-promise-id}

Input Parameters

promised_on

optional, timestamp(UTC) in seconds

Updated promised payment date as a UTC timestamp in seconds. Must be in the future.

reason

optional, string, max chars=500

Optional note describing the context or reason for capturing this promise. Replaces the stored value. If you leave out reason, the stored value is unchanged.

promised_by

optional, string, max chars=254

Name or identifier of the user or agent who captured this promise. Replaces the stored value.

Returns

collections_payment_promise

Collections payment promise object

The updated collections_payment_promise resource.