Event payment plans extend the normal CentriPOS receipt and customer-account workflow. The sale remains the booked total and open balance, sale_payments remains the only tender ledger, and invoice_billing_plans with invoice_installments stores the schedule. Event records add the offering policy and registration relationship; they do not copy money into a separate event ledger. This is a controlled-rollout capability, so a documented screen, API resource, webhook, or HighLevel definition is usable only after it is enabled for the selected business.
Step by step
- Open the offering and choose Payments. Confirm the business and the offering timezone before changing a policy. If Payments is absent, the event payment-plan rollout is not enabled for this business; do not simulate a plan with discounts, custom zero-dollar lines, duplicate receipts, or manually confirmed registrations.
- Keep Pay in full available unless the business has an approved reason to require a plan. For each plan, enter a staff-readable name and code, choose Draft or Active, decide whether customers may select it, and optionally limit it to one ticket option. Archive an obsolete policy instead of reusing its identity for different terms.
- Choose a percentage or fixed deposit. The server calculates the deposit from the authoritative quoted receipt total and rejects a deposit that is zero, equals the total, exceeds the total, or cannot leave valid installments. Browser-entered prices and dates are never payment-plan authority.
- Set the number of remaining installments, first-payment delay, cadence in days, weeks, or months, and optional final-due offset before the first event start. Set the grace period separately. Preview the real cent amounts and calendar dates in the offering timezone; the final installment absorbs any rounding remainder.
- Choose the capacity, admission, and delinquency behavior deliberately. The normal camp pattern is Deposit reserves capacity and confirms the registration, while a stricter event can require Paid in full before admission. A future installment is not delinquent; delinquency begins only when an unpaid due date passes its configured grace boundary.
- Review every ticket option covered by the policy. A plan applies to the complete qualifying event receipt, including separately sold shirts, kits, meals, or take-home robots on that receipt. If event tickets in one cart do not share a compatible offering policy and currency, split the purchases rather than joining incompatible schedules.
- Use the policy preview before publication. Confirm amount due today, balance after deposit, every installment amount and due date, final event deadline, grace period, capacity behavior, admission rule, customer-selectability, and affected ticket options. Publication validation should fail closed when the schedule cannot reconcile or extends beyond an enforced final deadline.
- At customer checkout, present Pay in full and each eligible Payment plan as keyboard-operable radio choices with visible focus. State the full total, amount due today, balance after deposit, every amount and due date, and capacity, cancellation, delinquency, and admission terms in text—not color alone. Put validation next to the affected choice and move focus to the error summary after a failed submission.
- When the customer chooses a plan, CentriPOS authorizes and records only the server-derived deposit. A successful deposit becomes a normal sale_payment; the receipt retains its full total, amount paid, and remaining balance; the receipt-backed A/R invoice and installment plan are created; and the storefront order becomes payment_plan_active. Registration and scarce-capacity commitments follow the immutable policy snapshot captured with the quote.
- Do not treat registration confirmation as proof of full payment. Registration status, plan status, installment status, receipt balance, and ticket/admission eligibility are separate fields. A policy may confirm a camper after the deposit while still showing an open customer balance, and a paid-in-full admission rule can withhold admission without putting a depositor back into an expiring pending hold.
- In the customer account experience, show one household receipt plan once even when it covers siblings or several registrations. Show deposit paid, total paid, remaining balance, next due date, past-due amount, schedule, plan status, and whether event admission has been released. Make a payment opens the ordinary branded receipt link: a scheduled installment amount may be prefilled as a suggestion, but the customer can choose the full balance or enter another positive partial amount up to the remaining balance. Never expose a vault token, processor payload, database route, or reusable payment capability.
- Apply every later card, ACH, cash, check, or other approved tender through the normal receipt payment workflow. CentriPOS allocates valid payments against the schedule and recalculates the plan; an extra payment reduces the balance and an early payoff completes it. Never mark an installment paid by editing a plan or event row, and never create a duplicate event payment to mirror a sale_payment.
- Use staff receipt and account controls to collect a payment or, when the operation is enabled, pause, resume, cancel the plan, send the branded customer payment link, or explicitly reinstate admission after a released plan is fully settled. Require an audit reason for a material schedule or lifecycle change. Reinstatement requires its own nonblank 1–1000 character reason and a unique Idempotency-Key. A plan setting does not authorize automatic card charges: auto-collection requires a supported saved method and separate timestamped customer consent.
- Read the lifecycle precisely. A plan can be Draft, Active, Paused, Delinquent, Completed, or Canceled; an installment can be Scheduled, Due, Processing, Paid, Failed, or Canceled; and a storefront schedule can be Pay in full, Pending deposit, Active, Delinquent, Completed, or Canceled. The registration keeps its own confirmed, waitlisted, cancelled, transferred, refunded, checked-in, or completed state as applicable.
- In Events → Registrations and Reports, show booked registration value, deposit and other completed cash collected, remaining scheduled balance, amount currently due, amount past due, refunds, next due date, plan status, and admission-released count/state as separate measures. Pending payments never count as collected or paid-in-full. Group registrations sharing one sale before totaling financial balances so a sibling household plan is not counted once per camper.
- For server integrations, use event-payment-plan-policies for offering policy CRUD and event-registration-payment-plans for the receipt-backed plan lifecycle. Every registration-plan GET requires invoices:read plus events:registrations:read. POST the collection to create a plan, then use /{registration_payment_plan_id}/pause, /resume, /cancel, /send-customer-link, or /reinstate-admission for explicit lifecycle work; every command requires events:registrations:write plus invoices:write, operation class payment_adjacent, and a unique Idempotency-Key. Create verifies that the tenant receipt has an event registration and matching event-ticket receipt line before calling the authoritative invoice-plan command. Pause, resume, and cancel change lifecycle state without recording money. send-customer-link returns a safe branded capability ready for caller delivery, not proof of delivery or payment. There is no mark-paid route and no command silently auto-charges a saved method. The OpenAPI x-centripos-status and runtime response remain the availability source of truth for each entitled tenant.
- Subscribe only enabled endpoints to event_payment_plan_policy.created, event_payment_plan_policy.updated, event_payment_plan_policy.archived, event_registration_payment_plan.activated, event_registration_payment_plan.paused, event_registration_payment_plan.resumed, event_registration_payment_plan.delinquent, event_registration_payment_plan.completed, event_registration_payment_plan.canceled, or event_registration_payment_plan.admission_reinstated, plus the existing sale and completed-payment events genuinely needed by the receiver. Policy delivery requires events:read; registration-plan delivery requires invoices:read. Verify the signed webhook, deduplicate its immutable event ID, and fetch broader financial detail only with a separately scoped key. Payloads exclude child-sensitive answers, medical or waiver data, card and vault data, raw processor responses, payment links, and command-only count output.
- After HighLevel Marketplace and per-location activation, use the matching payment-plan lifecycle triggers for appropriate reminders and household communications. Enabled actions are centripos_receipt_payment_plan_create, centripos_receipt_payment_plan_pause, centripos_receipt_payment_plan_resume, centripos_receipt_payment_plan_cancel, centripos_receipt_payment_plan_send_customer_link, and centripos_receipt_payment_plan_reinstate_admission. Reinstatement requires payment_plan_id and a nonblank reason, calls the same capacity-safe receipt-plan command, and returns safe registrations_reinstated, occurrence_enrollments_reinstated, seats_reinstated, and tickets_issued counts. There is intentionally no Mark paid action: money must arrive through an authoritative completed receipt tender with an external reference and audit evidence.
- For imported Event Espresso history, preserve each known transaction, payment entry, paid amount, balance, and registration state. Do not infer an installment schedule merely because a historical transaction was partially paid or had several payments; create historical plan rows only when the source contains explicit schedule terms. Reconcile a sample from registration to participant, household purchaser, ticket product, receipt line, sale payments, receipt balance, and any verified plan before enabling customer access or automation.
- For an API-created plan, POST /event-registration-payment-plans with sale_id, starts_on, interval_unit, interval_count, installment_count, and optional plan_name. Reuse the same Idempotency-Key for an uncertain retry. A new plan returns 201; a database-level replay can return 200. The result is the same receipt-backed invoice plan used by normal CentriPOS A/R, with bounded cancellation-reason-free registration links—not a duplicate event payment ledger.
- Use POST /event-registration-payment-plans/{registration_payment_plan_id}/pause, /resume, or /cancel with an optional 1–1000 character reason. Each returns the safe plan projection plus requested_status, prior_status, and lifecycle_result. These commands require both registration-write and invoice-write permission and never create sale_payments, mark an installment paid, refund a receipt, or imply card-on-file consent.
- Use POST /event-registration-payment-plans/{registration_payment_plan_id}/send-customer-link with optional installment_id and expires_minutes from 5 through 10,080. The returned customer_payment_link contains only a trusted tenant-bound HTTPS receipt URL, suggested amount, canonical expiry, reuse state, and ready_for_delivery status. The caller chooses an authorized delivery channel; the API response does not itself send a message. A replay under the same Idempotency-Key returns only the exact unchanged still-live capability. Expiry, token rotation, plan completion or cancellation, remaining-balance drift, or installment amount/status drift fails closed; after resolving the current state, submit the intended request with a new Idempotency-Key instead of accepting stale link data.
- When a configured post-grace policy releases capacity, CentriPOS records the admission-released state, cancels only the affected payment-plan registrations, voids their credentials, and atomically releases their preserved daypart or session occurrence selections and physical seat assignments. A late payoff settles the receipt but does not silently reclaim capacity. Staff must use the explicit reinstatement command after the current authoritative receipt balance is zero; the command locks and rechecks live registration, occurrence, and physical-seat availability, restores only the registrations, selections, and original still-available seats released for that receipt, restores or issues tickets, and fails closed without partial restoration if any required capacity is no longer available.
- Treat payment-link expiration as returned data, not a promise calculated from the request. requested_expires_minutes applies only when CentriPOS must create a new canonical receipt token. If a still-live canonical token is reused, the returned expires_at is its actual existing expiry and the request neither extends nor shortens it. Idempotent replay is deliberately state-bound: only the same unchanged still-live capability can replay. Expiry, token rotation, plan completion or cancellation, balance drift, or installment drift fails closed and requires a new Idempotency-Key for the intended current request. The scheduled installment in payment_url is only a payment_amount prefill on the ordinary receipt page; the customer may pay that amount, the full balance, or another valid partial amount.
- Use POST /event-registration-payment-plans/{registration_payment_plan_id}/reinstate-admission only after the authoritative receipt balance is zero and live capacity has been reviewed. Admission reinstatement returns lifecycle_result plus safe registrations_reinstated, occurrence_enrollments_reinstated, seats_reinstated, and tickets_issued counts. A successful first command reports the work performed; an idempotent replay reports lifecycle_result replayed and may return null counts. Customer portal and staff registration summaries continue to show admission released until the atomic command succeeds.
Screen and contract reference
| Control or area | What it means |
|---|---|
| Event payment-plan policy | Offering-level or ticket-specific rules for deposit, installments, capacity, admission, grace, delinquency, and customer selection. |
| Shared receipt ledger | sales carries the total and balance, sale_payments carries tender evidence, and no event table duplicates a payment. |
| Deposit | Server-calculated amount due at checkout before the remaining schedule is activated. |
| Amount due today | Authoritative deposit for a plan or the full total for Pay in full. |
| Installment schedule | Remaining cent-exact amounts and due dates stored through the normal invoice-plan foundation. |
| Final due offset | Optional rule requiring the last installment a configured number of days before the event begins. |
| Grace period | Time after a due date before an unpaid installment makes the plan delinquent under its policy. |
| Capacity policy | Whether a successful deposit reserves capacity, releases it after grace, or requires staff review. |
| Admission policy | Whether an active current plan is sufficient for entry or the receipt must be paid in full. |
| Delinquency policy | Manual review, portal pause, or approved post-grace cancellation behavior; it does not make a future balance past due. |
| payment_plan_active | Storefront order has a successful deposit and an active schedule for its remaining receipt balance. |
| Receipt-backed A/R invoice | Customer-account mirror of the same sale, not another sale or payment ledger. |
| Plan status | Draft, Active, Paused, Delinquent, Completed, or Canceled. |
| Installment status | Scheduled, Due, Processing, Paid, Failed, or Canceled. |
| One household plan | One sale-level balance shared by all registrations on the receipt; reports and portal views must not multiply it by camper count. |
| Customer-initiated payment | Approved tender entered through a branded receipt or account payment path and then allocated to the schedule. |
| Auto-collection consent | Separate, timestamped permission tied to a supported saved method; enabling a policy is not consent. |
| event-payment-plan-policies | Authenticated-live policy resource for entitled tenants: GET/POST collection and GET/PATCH/DELETE item operations under event scopes. |
| event-registration-payment-plans | Authenticated-live receipt-backed plan lifecycle: three dual-read-scope GET routes plus idempotent create, pause, resume, cancel, send-customer-link, and reinstate-admission commands under events:registrations:write plus invoices:write. Commands cannot mark paid or auto-charge. |
| Payment-plan webhook | Signed, retryable lifecycle notification with a complete scalar safe snapshot; policy objects use events:read and registration-plan objects use invoices:read. |
| HighLevel payment-plan action | Bounded authoritative command for plan creation or lifecycle communication; never a command to mark money paid. |
| Historical schedule caveat | Multiple Event Espresso payment rows or an open balance prove payment history, not agreed future installment dates. |
| Controlled rollout | The API routes are registered for entitled tenants; staff UI, customer experience, tenant rollout, webhook subscriptions, and HighLevel Marketplace activation must still each be verified. |
| Payment-plan command scopes | events:registrations:write plus invoices:write are required together for create, pause, resume, cancel, send-customer-link, and reinstate-admission; every command also requires Idempotency-Key. |
| payment_adjacent | Rate-limit and audit class for all six receipt-plan lifecycle commands; none is a mark-paid or automatic-charge operation. |
| Admission released | Capacity and credentials were released under the plan policy; receipt payoff alone does not reactivate attendance. |
| reinstate-admission | Idempotent paid-in-full, live-capacity-checked command with a required 1–1000 character audit reason; it restores the receipt registrations, daypart/session selections, original still-available physical seats, and tickets atomically. |
| Canonical payment-link expiry | The returned expires_at is authoritative; requested TTL applies only when a new receipt token is created. |
| Suggested installment amount | payment_amount prefill on the ordinary receipt link, not a forced charge; the customer may choose scheduled, full, or another valid partial amount. |
| Pending payment | Unsettled processor attempt that does not count as collected cash, plan completion, receipt paid-in-full, or admission eligibility. |
Expected result
The deposit, receipt total, completed sale payments, remaining balance, installment allocations, customer-account invoice, registration links, capacity behavior, and reported plan status reconcile to the cent; the customer can understand and operate the enabled payment path; and no event, API, webhook, HighLevel, or imported-history record fabricates a payment or schedule.
Troubleshooting
- Confirm the exact offering, occurrence, ticket option, timezone, and participant before changing registration or attendance.
- Check shared capacity pools and linked morning, afternoon, or full-day sessions before changing availability.
- Keep camper, guardian, medical, waiver, and pickup details out of public feeds, screenshots, webhooks, and general CRM fields.
CentriPOS API explorer · API Center administration