> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corafone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# payment.plan_created

> Webhook event when a payment plan is saved (tokenized or USAePay).

## Event

`payment.plan_created`

Sent only from:

* **Unified tokenized** flows when a `payment` or `payment plan` is setup, with a tokenized payment process.
* **USAePay** payment processing when a `plan` or `payment` is set up.

SCollect, eCollect, and other direct CRM integrations do **not** emit this event. As the plans go straight into their service.

The HTTP body uses the [standard webhook envelope](/webhooks): top-level `event`, `eventCategory`, `organization`, optional `agent`, `timestamp`, and **`payload`** — the object below is the **`payload`** value.

Treat `tokenized` as sensitive (processor payment key / token). Use HTTPS, protect your signing secret, and avoid logging full bodies.

## How `payload` is built

Cora merges normalized fields with plan-specific data. Optional passthrough when present: `consumerId`, `currency`, `externalId`, `accountId`, `gateway`, `outcome`.

## Normalized and plan fields (inner `payload`)

| Field                  | Description                                                                                                                                                                             |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title`                | `"<Organization name> Payment Plan Created"`                                                                                                                                            |
| `name`                 | Customer / payor name when provided                                                                                                                                                     |
| `fileNumber`           | Account / file reference uploaded with                                                                                                                                                  |
| `balance`              | Balance string when provided                                                                                                                                                            |
| `callId`               | Voice / session id when provided (e.g. metadata `runId`)                                                                                                                                |
| `tokenized`            | Processor token / payment key when provided                                                                                                                                             |
| `paymentType`          | Instrument hint: `card`, `ach`, or `wallet` (voice flows default to `card`)                                                                                                             |
| `totalAmount`          | Sum of scheduled payment amounts (string, two decimals)                                                                                                                                 |
| `paymentDate`          | First scheduled payment date (`YYYY-MM-DD`)                                                                                                                                             |
| `numberOfInstallments` | Length of the `payments` array                                                                                                                                                          |
| `amountPerInstallment` | Configured per-installment amount string                                                                                                                                                |
| `downPayment`          | Down payment from plan config (`0.00` when none)                                                                                                                                        |
| `regularity`           | `weekly`, `biweekly`, `monthly`, or `one_time`                                                                                                                                          |
| `planType`             | One of: `settle_today`, `settlement_plan`, `regular_payment_plan`, `single_payment`                                                                                                     |
| `payments`             | Array of `{ paymentDate, amount, processed }` — `processed` is `true` only for the first row when an immediate charge succeeded (e.g. tokenized `paymentToday` or USAePay plan success) |
| `phoneNumber`          | Phone when provided                                                                                                                                                                     |
| `agentName`            | Agent display name when provided                                                                                                                                                        |

## Example payload

```json theme={null}
{
  "title": "Acme Corp Payment Plan Created",
  "name": "Jane Smith",
  "fileNumber": "12345",
  "balance": "1250.00",
  "callId": "call_abc123",
  "tokenized": "token_abc123",
  "paymentType": "card",
  "totalAmount": "500.00",
  "paymentDate": "2026-01-30",
  "numberOfInstallments": 5,
  "amountPerInstallment": "100.00",
  "downPayment": "100.00",
  "regularity": "weekly",
  "planType": "settlement_plan",
  "payments": [
    { "paymentDate": "2026-01-30", "amount": "100.00", "processed": true },
    { "paymentDate": "2026-02-07", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-14", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-21", "amount": "100.00", "processed": false },
    { "paymentDate": "2026-02-28", "amount": "100.00", "processed": false }
  ],
  "phoneNumber": "+15125550123",
  "agentName": "Collections Agent"
}
```
