RecurringDonationDesignation
Much like a Designation, A RecurringDonationDesignation conveys how much of a RecurringDonation goes to a particular Fund.
Example Request
curl https://api.planningcenteronline.com/giving/v2/recurring_donations/{recurring_donation_id}/designations
View in API Explorer →
Example Object
{
"type": "RecurringDonationDesignation",
"id": "1",
"attributes": {
"amount_cents": 1,
"amount_currency": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
amount_cents |
integer |
Required. The number of cents that will be donated to a recurring donation designation's associated fund. |
amount_currency |
string |
The currency of `amount_cents`. Set to the currency of the associated organization. |
id |
primary_key |
The unique identifier for a recurring donation designation. |
Can Include
| Parameter |
Value |
Description |
Assignable |
| include |
fund |
include associated fund |
|
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 |
/giving/v2/recurring_donations/{recurring_donation_id}/designations |
Reading
| HTTP Method |
Endpoint |
| GET |
/giving/v2/recurring_donations/{recurring_donation_id}/designations/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/recurring_donations/{recurring_donation_id}/designations/{recurring_donation_designation_id}/fund |
Fund
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/recurring_donations/{recurring_donation_id}/designations |
RecurringDonation
|
|
|