# Collections Payment Promise

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


A collections payment promise represents a customer's commitment to pay a specific invoice by a promised date. A promise is `active` until it ends:

-   `fulfilled`: the invoice is paid on or before `promised_on`.
-   `broken`: the invoice is paid after `promised_on`, or is still unpaid when `promised_on` passes.
-   `cancelled`: you cancel the promise, or the invoice is voided, written off, or deleted.

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

## Sample Collections payment promise

```json
{
  "id": "pp_8aspTSOcUcz72s",
  "customer_id": "__test__8aspTSOcUcz72s",
  "invoice_id": "__demo_inv__4",
  "promised_by": "ops.user@chargebee.com",
  "promised_on": 1738512000,
  "status": "active",
  "created_at": 1738508400,
  "updated_at": 1738512100,
  "resource_version": 1738512100000,
  "object": "collections_payment_promise"
}
```

## Collections Payment Promise attributes

## Input Parameters

- `id` (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 this promise covers.

- `status` (required, enumerated string)
  Current lifecycle state of the payment promise.
  Possible enum values:
    - `active`
      The promise is active and awaiting payment.
    - `fulfilled`
      The invoice was paid by `promised_on`.
    - `broken`
      The promised payment was not received by the promised date.
    - `cancelled`
      The payment promise was cancelled, or its invoice was voided, written off, or deleted.

- `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 of the date by which the customer promised 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.