Collections Payment Promise

Tracks a customer's commitment to pay. Pass amount and currency_code when creating the promise. The stored promise records the promise date, an optional invoice, and the status (active, fulfilled, broken, or cancelled).

Receivables must be enabled for the site. If it is not, these operations are rejected.

Sample Collections payment promiseJSON

Collections Payment Promise attributes

required, string, max chars=40

Unique identifier of the collections payment promise.

customer_id

required, string, max chars=100

Identifier of the customer who made this payment promise.

invoice_id

required, string, max chars=100

Identifier of the invoice linked to this promise, when the promise is invoice-specific.

status

required, enumerated string

Current lifecycle state of the payment promise.

Enum Values

active

The promise is active and awaiting payment.

fulfilled

The promised payment has been received.

broken

The promised payment was not received by the promised date.

cancelled

The payment promise was cancelled.

reason

optional, string, max chars=500

Optional note describing the context or reason for capturing this promise.

promised_by

optional, string, max chars=254

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

promised_on

required, timestamp(UTC) in seconds

Timestamp in UTC seconds representing when the customer committed to pay.

created_at

required, timestamp(UTC) in seconds

Timestamp in UTC seconds when this collections payment promise was created.

updated_at

required, timestamp(UTC) in seconds

Timestamp in UTC seconds when this collections payment promise was last updated.

resource_version

optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource.