v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Recurring Donation Plan

listOrganizationRecurringDonationPlans

Retrieves a list of all Recurring Donation Plans for a specific Organization

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

Path parameters

organizationinteger required

Example:82364

The specified Organization ID

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": [
    {
      "address": "533 F Street",
      "address2": "Unit 26",
      "applied_fot_percent": 4,
      "campaign_id": 227362,
      "canceled_at": "2016-01-01T12:00:00+0000",
      "cancel_by": "supporter",
      "cancel_reason_code": "1",
      "cancel_reason_text": "Can no longer afford it",
      "cc_card_exp": "201204",
      "cc_last_four": "1223",
      "ach_last_four": 6789,
      "cc_type": "Visa",
      "city": "San Diego",
      "company_name": "Test Company",
      "country": "US",
      "created_at": "2016-01-01T12:00:00+0000",
      "currency_code": "USD",
      "designation_id": 34672,
      "donation_amount": 1,
      "failed_at": "2016-01-01T12:00:00+0000",
      "fee_on_top": true,
      "first_name": "John",
      "frequency": "bi-weekly",
      "fundraising_page_id": 2173528,
      "fundraising_team_id": 209745,
      "id": 85456,
      "is_anonymous": true,
      "hide_amount": true,
      "can_be_reactivated": true,
      "last_name": "Doe",
      "member_id": 2012,
      "metadata": {
        "foo": "bar"
      },
      "next_processing_date": "2016-01-01",
      "organization_id": 82364,
      "pause_until": "2023-04-01",
      "plan_paused_on_date": "2023-01-01",
      "payment_gateway": "PayPal",
      "payment_provider_configuration_name": "Classy Pay",
      "payment_type": "ACH",
      "postal_code": "92101",
      "pp_plan_id": "691e1e8d2add8",
      "raw_currency_code": "JPY",
      "raw_donation_amount": "50.00",
      "recur_until": "2021-01-01",
      "schedule": {
        "mmdd": "0109",
        "month": "January",
        "day": 9
      },
      "started_at": "2021-01-01T12:00:00+0000",
      "state": "CA",
      "status": "active",
      "supporter_id": 5827,
      "timezone_identifier": "UTC",
      "updated_at": "2021-01-01T13:00:00+0000",
      "is_donor_covered_fee": true,
      "raw_initial_gross_amount": 1.25,
      "raw_adjustment_amount": 0.25,
      "dcf_enabled": true,
      "dcf_allowed": true,
      "classy_mode_enabled": true,
      "effective_fixed_fot_percent": "5.00",
      "migrated": true,
      "migration_date": "2021-01-01T13:00:00+0000"
    }
  ],
  "first_page_url": "{host}/organizations/{organization}/recurring-donation-plans?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/organizations/{organization}/recurring-donation-plans?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/organizations/{organization}/recurring-donation-plans",
  "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
}