Registration
Example Request
curl https://api.planningcenteronline.com/registrations/v2/registrations
Example Object
{
"type": "Registration",
"id": "1",
"attributes": {
"created_at": "2000-01-01T12:00:00Z",
"total_cost": "string",
"total_cost_cents": 1,
"total_due": "string",
"total_due_cents": 1,
"total_paid": "string",
"total_paid_cents": 1,
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name | Type | Description |
|---|---|---|
created_at |
date_time |
|
id |
primary_key |
|
total_cost |
string |
The registration's total cost after discounts, formatted with the signup's
currency symbol (for example |
total_cost_cents |
integer |
The registration's total cost after discounts, in cents. |
total_due |
string |
The registration's outstanding balance, formatted with the signup's currency
symbol (for example |
total_due_cents |
integer |
The registration's outstanding balance in cents. Accounts for discounts and every attendee on the registration. |
total_paid |
string |
The total amount paid toward the registration, formatted with the signup's
currency symbol (for example |
total_paid_cents |
integer |
The total amount paid toward the registration, in cents. |
updated_at |
date_time |
Can Include
| Parameter | Value | Description | Assignable |
|---|---|---|---|
| include | created_by | include associated created_by |
|
| include | registrant_contact | include associated registrant_contact |
Order By
| Parameter | Value | Type | Description |
|---|---|---|---|
| order | created_at | string | prefix with a hyphen (-created_at) to reverse the order |
| order | updated_at | string | prefix with a hyphen (-updated_at) to reverse the order |
Pagination
| Name | Parameter | Type | Description |
|---|---|---|---|
| per_page | per_page | integer | how many records to return per page (min=1, max=100, default=25) |
| offset | offset | integer | get results from given offset |
Endpoints
Listing
| HTTP Method | Endpoint |
|---|---|
| GET | /registrations/v2/registrations |
Notes:
Organization admins can see all registrations for all signups. Signup managers can only see the registrations for signups they manage. Individual registration access requires admin-level event permissions.
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /registrations/v2/registrations/{id} |
Notes:
Organization admins can see all registrations for all signups. Signup managers can only see the registrations for signups they manage. Individual registration access requires admin-level event permissions.
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/registrations/v2/registrations/{registration_id}/created_by |
Person | ||
| GET | https://api.planningcenteronline.com/registrations/v2/registrations/{registration_id}/registrant_contact |
Person |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/registrations/v2/attendees/{attendee_id}/registration |
Attendee | ||
| GET | https://api.planningcenteronline.com/registrations/v2/registrations |
Organization | ||
| GET | https://api.planningcenteronline.com/registrations/v2/signups/{signup_id}/registrations |
Signup |