latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Recurring plans

Get a recurring plan

This request allows you to read your Fundraise Up recurring plan record. The supporter data will be displayed as it appears on the Recurring plan page in your Dashboard.

get/v1/recurring_plans/{id}

Path parameters

idstring required

Example:RXXXXXXX

Unique identifier of the recurring plan, formatted as R[A-Z]{7}.

Query parameters

livemodeboolean

Example:true

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026.

Response

On success, the API returns the recurring plan object.

amountstring required

Donation amount for each recurring installment, in the plan's currency.

amount_before_fees_coveredstring required

Amount before fees were covered by supporter.

amount_before_fees_covered_in_default_currencystring required

Amount before fees were covered by supporter, converted to the organization's default currency at the time of the donation.

amount_in_default_currencystring required

Donation amount for each recurring installment, converted to the organization's default currency at the time of the donation.

anonymousboolean required

Indicates if the recurring donations are made anonymously (true) or not (false).

cancellation_detailsstring nullable required

Additional details about the cancellation provided by the supporter. Can be null when not provided or when the plan is not canceled.

The reason category selected when the recurring plan was canceled. Can be null when no reason category was selected or when the plan is not canceled.

commentstring nullable required

Optional comment attached to the recurring donation plan.

created_atstring required

Timestamp in ISO 8601 format, indicating when the recurring plan was created in UTC.

currency'shp' | 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'ang' | 'xcg' | 'awg' | 'azn' | 'bam' | 'bbd' | 'inr' | 'pkr' | 'bdt' | 'xof' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'myr' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'btn' | 'nok' | 'zar' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'xaf' | 'chf' | 'nzd' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'etb' | 'fjd' | 'fkp' | 'jpy' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'idr' | 'ils' | 'isk' | 'jmd' | 'jod' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'sek' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sgd' | 'sll' | 'sle' | 'sos' | 'srd' | 'std' | 'svc' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'zmw' | 'btc' | 'eth' | 'usdt' | 'usdc' | 'sol' | 'dot' | 'doge' | 'shib' | 'ltc' | 'bch' | 'xtz' | 'fil' | 'ftm' | 'gala' | 'paxg' | 'zec' required

Three-letter ISO currency code, in lowercase.

ended_atstring nullable required

Timestamp in ISO 8601 format, indicating when the recurring plan ended in UTC.

Frequency of the recurring plan.

idstring required

Unique identifier for the recurring donation plan.

livemodeboolean required

Test mode indicator. true for recurring plans in live mode, false for recurring plans in test mode.

next_installment_atstring nullable required

Timestamp in ISO 8601 format, indicating the next scheduled donation installment in UTC.

on_behalf_ofstring nullable required

Name of the organization the donation was made on behalf of.

Source of the recurring donation setup.

source_of_funds'own_money' | 'on_behalf_of' | 'fundraising_or_collection' nullable required

Indicates the source of funds for the donation in the context of Gift Aid eligibility.

Status of the recurring plan.

supporter_covered_feestring required

Amount of fees covered by the supporter.

supporter_covered_fee_in_default_currencystring required

Amount of fees covered by the supporter and converted to the organization's default currency.

urlstring nullable required

URL where the recurring donation was set up.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "amount": "99.99",
  "amount_before_fees_covered": "99.99",
  "amount_before_fees_covered_in_default_currency": "59.99",
  "amount_in_default_currency": "59.99",
  "benefit": {
    "code": "TSHIRT-001",
    "fair_market_value": "25.99",
    "fair_market_value_currency": "usd",
    "id": "GXXXXXXX",
    "name": "T-shirt",
    "option": {
      "code": "SIZE-M",
      "name": "Size",
      "value": "M"
    },
    "shipping": {
      "address": {
        "city": "Nashville",
        "country": "us",
        "line1": "123 Example St.",
        "line2": "Apt. 1",
        "postal_code": "111111",
        "region": "Tennessee"
      },
      "recipient_first_name": "Alex",
      "recipient_last_name": "Garcia"
    }
  },
  "campaign": {
    "code": "Code-1",
    "id": "FUNXXXXXXXX",
    "name": "My Campaign"
  },
  "cancellation_details": "Moving to a different organization",
  "cancellation_reason": "financial_difficulty",
  "comment": "comment example",
  "consent": {
    "customized": {
      "email": "opted_in",
      "phone_calls": "opted_out",
      "postal_mail": "opted_in",
      "sms": "opted_in",
      "social_media": "opted_out"
    },
    "general": "opted_in"
  },
  "created_at": "2024-12-20T00:00:00.000Z",
  "currency": "usd",
  "custom_fields": [
    {
      "name": "Field1",
      "value": "Value1"
    }
  ],
  "designation": {
    "code": "Code-1",
    "id": "EXXXXXXX",
    "name": "My Designation"
  },
  "device": {
    "browser": "Chrome",
    "ip": {
      "address": "111.111.111.111",
      "city": "Nashville",
      "country_name": "United States",
      "region": "Tennessee"
    },
    "os": "MacOS",
    "type": "desktop",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
  },
  "element": {
    "id": "XXXXXXXX",
    "name": "My Element",
    "type": "donationForm"
  },
  "ended_at": "2024-12-20T00:00:00.000Z",
  "frequency": "monthly",
  "fundraiser": {
    "id": "NXXXXXXX",
    "name": "Run for hope"
  },
  "gift_aid": {
    "claimed": true,
    "legal_text": "I am a UK taxpayer and want to claim Gift Aid."
  },
  "id": "RXXXXXXX",
  "livemode": true,
  "next_installment_at": "2024-12-20T00:00:00.000Z",
  "on_behalf_of": "Example Inc.",
  "payment": {
    "bank_account": {
      "last4": "1234"
    },
    "credit_card": {
      "exp_month": "12",
      "exp_year": "2023",
      "last4": "1234",
      "type": "Visa"
    },
    "email": "example@example.com",
    "error_message": "Something went wrong",
    "method": "paypal",
    "processor": "stripe"
  },
  "questions": [
    {
      "code": "Code-1",
      "id": "QXXXXXXX",
      "checked": true,
      "options": [
        "OK",
        "Good"
      ],
      "text": "Example answer"
    }
  ],
  "source": "website",
  "status": "active",
  "supporter": {
    "address": {
      "city": "Nashville",
      "country": "us",
      "line1": "123 Example St.",
      "line2": "Apt. 1",
      "postal_code": "111111",
      "region": "Tennessee"
    },
    "email": "example@example.com",
    "employer": {
      "name": "Fundraise Up Inc."
    },
    "employment_status": "employed",
    "first_name": "Alex",
    "id": "SXXXXXXXX",
    "language": "en-CA",
    "last_name": "Garcia",
    "occupation": "Software Engineer",
    "phone": "+1 (111) 111111",
    "title": "mr"
  },
  "supporter_covered_fee": "9.99",
  "supporter_covered_fee_in_default_currency": "99.9",
  "tribute": {
    "honoree": "Zhang Wei",
    "id": "TXXXXXXX",
    "sharing": {
      "from": "Alex Garcia",
      "message": "In loving memory of Jordan",
      "recipient": {
        "address": {
          "city": "Nashville",
          "country": "us",
          "line1": "123 Example St.",
          "line2": "Apt. 1",
          "postal_code": "111111",
          "region": "Tennessee"
        },
        "email": "example@example.com",
        "first_name": "Sidney",
        "last_name": "Jones",
        "title": "mr"
      },
      "type": "email"
    },
    "type": "in_honor"
  },
  "url": "https://example.com/RXXXXXXX",
  "utm": {
    "campaign": "giving_tuesday",
    "content": "textlink",
    "medium": "email",
    "source": "google",
    "term": "how_to_support_penguins"
  }
}