| Property | Value |
|---|---|
| Product | Registrations (pco.registrations, API version 2025-05-01) |
| Resource type | Registration |
| TypeScript | Registrations.Registration, attributes Registrations.RegistrationAttributes, schema Registrations.RegistrationSchema |
| Planning Center path | /registrations/v2/registrations |
| Planning Center docs | Registration |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.registrations.registrations |
Collection | No | |
pco.registrations.attendees.id(attendeeId).registration |
Collection | No | |
pco.registrations.signups.id(signupId).registrations |
Collection | No |
From a collection, .id(registrationId) addresses one Registration: pco.registrations.registrations.id(registrationId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Registrations.RegistrationAttributes. Every resource also has id and type ('Registration') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
total_cost |
string | null |
The registration’s total cost after discounts, formatted with the signup’s currency symbol (for example "$120.00"). null for a free registration. Accounts for discounts and every attendee on the registration. |
total_cost_cents |
number | null |
The registration’s total cost after discounts, in cents. 0 for a free registration. Accounts for discounts and every attendee on the registration. |
total_due |
string | null |
The registration’s outstanding balance, formatted with the signup’s currency symbol (for example "$120.00"). Accounts for discounts and every attendee on the registration. |
total_due_cents |
number | null |
The registration’s outstanding balance in cents. Accounts for discounts and every attendee on the registration. |
total_paid |
string | null |
The total amount paid toward the registration, formatted with the signup’s currency symbol (for example "$120.00"). |
total_paid_cents |
number | null |
The total amount paid toward the registration, in cents. |
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): created_by, registrant_contact.
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, updated_at.
Edges
Follow these from one Registration, ref = pco.registrations.registrations.id(registrationId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.created_by |
Person | Collection | No | |
ref.registrant_contact |
Person | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Registrations } from '@mackenly/planningcenterkit';
const page = await pco.registrations.registrations.order('created_at').perPage(25).list();
const items: Registrations.Registration[] = page.data;