A Refund record holds information pertaining to a refunded Donation.
| Property | Value |
|---|---|
| Product | Giving (pco.giving, API version 2019-10-18) |
| Resource type | Refund |
| TypeScript | Giving.Refund, attributes Giving.RefundAttributes, schema Giving.RefundSchema |
| Planning Center path | /giving/v2/donations/{donation_id}/refund |
| Planning Center docs | Refund |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.giving.donations.id(donationId).refund |
Single resource | No |
Collections support where, include, order, and pagination; single resources have get().
Attributes
On Giving.RefundAttributes. Every resource also has id and type ('Refund') next to its attributes.
| Name | Type | Description |
|---|---|---|
amount_cents |
number | null |
The number of cents being refunded. |
amount_currency |
string | null |
The currency of amount_cents. |
created_at |
string | null |
The date and time at which a refund was created. Example: 2000-01-01T12:00:00Z |
fee_cents |
number | null |
The payment processing fee returned by Stripe, if any. |
fee_currency |
string | null |
The currency of fee_cents. |
refunded_at |
string | null |
The date and time at which a refund was processed. Example: 2000-01-01T12:00:00Z |
updated_at |
string | null |
The date and time at which a refund was last updated. Example: 2000-01-01T12:00:00Z |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): designation_refunds.
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Giving } from '@mackenly/planningcenterkit';
function describe(resource: Giving.Refund): string {
return `${resource.type} ${resource.id}`;
}