v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Recurring Donation Plan History

listOrganizationRecurringDonationPlanHistory

Retrieve a list of all the Recurring Donation Plan History for the given organization.

get/organizations/{organization}/recurring-donation-history

Path parameters

organizationinteger required
Example:82364

Primary identifier of Organization

Query parameters

pageinteger
Example:1

Indicator of which page of results to return

per_pageinteger
Example:20

Number of entries to return in each page of results

Response

Success

current_pageinteger

Index of current page

first_page_urlstring nullable

URL of first page of results

frominteger nullable

Index of first displayed result within total result set

last_pageinteger

Index of last page in result set

last_page_urlstring nullable

URL of last page of results

next_page_urlstring nullable

URL of next page of results

pathstring nullable

URL of current page of results

per_pageinteger

Maximum number of records returned per page of results

prev_page_urlstring nullable

URL of previous page of results

tointeger nullable

Index of last displayed result within total result set

totalinteger

Total count of records in result set

Example response

{
  "current_page": 1,
  "data": [
    {
      "error_msg": "There was an error",
      "raw_currency_code": "CAD",
      "raw_donation_amount": 50,
      "type": "created",
      "id": 559879,
      "recurring_id": 85456,
      "transaction_id": 1427264,
      "currency_code": "USD",
      "donation_amount": 50,
      "created_at": "2019-04-23T10:25:03Z"
    }
  ],
  "first_page_url": "{host}/organizations/{organization}/recurring-donation-history?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/organizations/{organization}/recurring-donation-history?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/organizations/{organization}/recurring-donation-history",
  "per_page": 20,
  "prev_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "links": [
    {
      "label": "1",
      "url": "{host}/{resource}?page=1",
      "active": true
    }
  ],
  "to": 1,
  "total": 1
}