Pledge - Giving API - Planning Center

Example Request

curl https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges

View in API Explorer →

Example Object

{
  "type": "Pledge",
  "id": "1",
  "attributes": {
    "amount_cents": 1,
    "amount_currency": "USD",
    "created_at": "2000-01-01T12:00:00Z",
    "donated_total_cents": 1,
    "joint_giver_amount_cents": 1,
    "joint_giver_donated_total_cents": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "pledge_campaign": {
      "data": {
        "type": "PledgeCampaign",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`amount_cents`	`integer`	The amount pledged
`amount_currency`	`currency_abbreviation`
`created_at`	`date_time`
`donated_total_cents`	`integer`	The amount donated
`id`	`primary_key`
`joint_giver_amount_cents`	`integer`	The amount pledged by the joint giver, if in a joint giving unit
`joint_giver_donated_total_cents`	`integer`	The amount donated by the joint giver, if in a joint giving unit
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
pledge_campaign	PledgeCampaign	to_one

Can Include

Parameter	Value	Description	Assignable
include	joint_giver	include associated joint_giver
include	pledge_campaign	include associated pledge_campaign	create and update

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

Query By

Name	Parameter	Type	Description	Example
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
updated_at	`where[updated_at]`	date_time	Query on a specific updated_at	`?where[updated_at]=2000-01-01T12:00:00Z`

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/people/{person_id}/pledges`

Reading

HTTP Method	Endpoint
GET	`/giving/v2/people/{person_id}/pledges/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/giving/v2/people/{person_id}/pledges`	amount_cents person_id pledge_campaign_id

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/giving/v2/people/{person_id}/pledges/{id}`	amount_cents

Deleting

HTTP Method	Endpoint
DELETE	`/giving/v2/people/{person_id}/pledges/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges/{pledge_id}/joint_giver`	Person
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges/{pledge_id}/pledge_campaign`	PledgeCampaign

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges`	Person
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/pledges/{pledge_id}/pledge_campaign/{pledge_campaign_id}/pledges`	PledgeCampaign