Recurring Donations

Cancel an unmanaged recurring donation

Changed on

Cancels a recurring donation NationBuilder does not bill. Recurring donations NationBuilder bills are canceled in the control panel or the supporter portal, and return 400 here.

The recurring donation is always canceled immediately: its status becomes canceled, canceled_date is set, and a Recurring Donation Canceled activity is written. What happens to the membership it pays for depends on the body.

data.canceled_date — stamps that date on the recurring donation and its activity instead of now. Send this to import a series that already ended. It only changes the recorded date: the membership is still canceled now unless data.membership_expires_on is sent.

No data.membership_expires_on — the membership is canceled now as well.

data.membership_expires_on — the membership stays active until that date, with a Membership Cancelation Scheduled activity attributed to the token owner. The nightly membership job cancels it on that date. Send this to honour the period the donor already paid for. There is no default; the recurring donation's next_bill_date is not used as one.

patch/api/v2/recurring_donations/{id}/cancel

Request

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

Request body

Example request

{
  "data": {
    "membership_expires_on": "2026-12-01",
    "canceled_date": "2025-03-01T00:00:00Z"
  }
}

Response

The canceled recurring donation.

metaobject

Non-standard information about the document. 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"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes