NAnationbuilder
Recurring Donations

List all recurring donations in a nation

Changed on

Lists recurring donations. A recurring donation is managed when NationBuilder bills it and unmanaged when an external processor bills it and NationBuilder only records it. Use filter[managed]=false to list unmanaged recurring donations.

get/api/v2/recurring_donations

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Query parameters

filter[managed]boolean

Filters by whether NationBuilder bills the recurring donation. false lists recurring donations an external processor bills.

filter[status]string[]

Filters by status. Comma-delimited values act as OR.

page[number]string

Page number to list (starting at 1)

page[size]string

Number of results to display per page (default: 20, max: 100, min: 1)

Response

A page of matching recurring donations.

metaobject

Non-standard information about the document, such as requested statistics. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": [
    {
      "id": "1",
      "type": "recurring_donations",
      "attributes": {
        "amount_in_cents": 1000,
        "description": "Monthly supporter",
        "donation_tracking_code_id": "1",
        "external_id": "sub_123",
        "frequency": "monthly",
        "page_id": "1",
        "recruiter_id": "1",
        "signup_id": "1",
        "start_date": "2019-10-26T10:00:00-04:00",
        "status": "active",
        "canceled_date": "2019-10-26T10:00:00-04:00",
        "created_at": "2019-10-26T10:00:00-04:00",
        "last_pay_date": "2019-10-26T10:00:00-04:00",
        "merchant_account_id": "1",
        "next_bill_date": "2019-10-26T10:00:00-04:00",
        "payment_type": "donation",
        "updated_at": "2019-10-26T10:00:00-04:00"
      }
    }
  ],
  "links": {
    "self": "/articles?page[number]=2",
    "first": "/articles?page[number]=1",
    "last": "/articles?page[number]=5",
    "prev": "/articles?page[number]=1",
    "next": "/articles?page[number]=3"
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes