An inactive reason is a small bit of text indicating why a member is no longer active.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | InactiveReason |
| TypeScript | People.InactiveReason, attributes People.InactiveReasonAttributes, schema People.InactiveReasonSchema |
| Planning Center path | /people/v2/inactive_reasons |
| Planning Center docs | InactiveReason |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.inactive_reasons |
Collection | Yes | |
pco.people.people.id(personId).inactive_reason |
Collection | No |
From a collection, .id(inactiveReasonId) addresses one InactiveReason: pco.people.inactive_reasons.id(inactiveReasonId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.InactiveReasonAttributes. Every resource also has id and type ('InactiveReason') next to its attributes.
| Name | Type | Description |
|---|---|---|
value |
string | null |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
value |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: value.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.people.inactive_reasons |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.InactiveReasonSchema['create'].
| Attribute | Type |
|---|---|
value |
string | null |
Update attributes
Typed as People.InactiveReasonSchema['update'].
| Attribute | Type |
|---|---|
value |
string | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.inactive_reasons.order('value').perPage(25).list();
const items: People.InactiveReason[] = page.data;