Much like a Designation, A RecurringDonationDesignation conveys how much of a RecurringDonation goes to a particular Fund.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | RecurringDonationDesignation |
| TypeScript | Giving.RecurringDonationDesignation, attributes Giving.RecurringDonationDesignationAttributes, schema Giving.RecurringDonationDesignationSchema |
| Planning Center path | /giving/v2/recurring_donations/{recurring_donation_id}/designations |
| Planning Center docs | RecurringDonationDesignation |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.recurring_donations.id(recurringDonationId).designations |
Collection | No |
From a collection, .id(recurringDonationDesignationId) addresses one RecurringDonationDesignation: pco.giving.recurring_donations.id(recurringDonationId).designations.id(recurringDonationDesignationId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.RecurringDonationDesignationAttributes. Every resource also has id and type ('RecurringDonationDesignation') next to its attributes.
| Name | Type | Description |
|---|---|---|
amount_cents |
number | null |
Required. The number of cents that will be donated to a recurring donation designation’s associated fund. |
amount_currency |
string | null |
The currency of amount_cents. Set to the currency of the associated organization. |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): fund.
| Relationship | Type | To | Includable |
|---|---|---|---|
fund |
To one | Fund | Yes |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one RecurringDonationDesignation, ref = pco.giving.recurring_donations.id(recurringDonationId).designations.id(recurringDonationDesignationId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.fund |
Fund | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Giving } from '@mackenly/planningcenterkit';
const recurringDonationId = '1'; // RecurringDonation id
const page = await pco.giving.recurring_donations.id(recurringDonationId).designations.perPage(25).list();
const items: Giving.RecurringDonationDesignation[] = page.data;