Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Recurring Donation Plan

fetchRecurringDonationPlan

Fetch specified Recurring Donation Plan

get/recurring-donation-plans/{recurring_donation_plan}

Path parameters

recurring_donation_planinteger required
Example:85456

Primary identifier of Recurring Donation Plan

Response

Success

addressstring

Line one of Billing address

address2string nullable

Line two of Billing address

applied_fot_percentnumber float nullable

The percentage to be added to all fee on top (aka Classy Mode) transactions created for this plan

campaign_idinteger

ID for Recurring Donation Plan's Campaign

canceled_atstring date-time nullable

Datetime representing cancellation time(can be null)

cancel_by'admin' | 'supporter' nullable

Type of user that cancelled Recurring Donation Plan

cancel_reason_codestring nullable

Cancellation reason code

cancel_reason_textstring nullable

Cancellation reason for Recurring donation Plan

cc_card_expstring

Expiration date for the credit card used

cc_last_fourstring

Last four digits of the credit card used

ach_last_fourinteger nullable

If the payment type is ACH, the last 4 digits of the ACH transaction is stored

cc_typestring nullable

Type of credit card used

citystring

Billing city

company_namestring nullable

Company of recurring donator

countrystring

Billing country

created_atstring date-time

Recurring Donation Plan created date

currency_codestring

ISO currency code for the Recurring Donation Plan

designation_idnumber nullable

ID for the Designation the Transactions created from the recurring Donation Plan will be allocated

donation_amountnumber float

Recurring Donation amount in the organization's currency

failed_atstring date-time nullable

Datetime representing the last time the recurring Donation failed

fee_on_topboolean

Flag describing if the recurring donation covers fees (classymode)

first_namestring

Donator's First Name

frequency'bi-weekly' | 'bi-monthly' | 'daily' | 'monthly' | 'one-time' | 'quarterly' | 'semi-annually' | 'weekly' | 'yearly'

Rate at which a recurring transaction against this plan is made

fundraising_page_idinteger nullable

Fundraising Page ID of recurring donator

fundraising_team_idinteger nullable

Fundraising Team ID of recurring donator

idinteger

ID of Recurring Donation Plan

is_anonymousboolean

Flag determining if the Transactions should be anonymized

hide_amountboolean

Flag determining if the Transactions amount should be anonymized

is_gift_aidboolean

Flag whether the Donor opts into gift aid used by the UK or not. Can only be set if the Organization allows it

is_pausedboolean

Flag which indicates if the recurring donation is paused. Can be set by Admin or the donor

can_be_reactivatedboolean

Whether the plan can be reactivated through Supporter Center. True only when the plan's current internal_status is in [canceled, failed, ended] AND the org still has an active ClassyPay PPC attached. False otherwise (wrong starting status, missing pp_plan_id, no PPC, or non-ClassyPay PPC).

last_namestring

Last name of recurring Donator

member_idinteger

Member ID of recurring donatior

next_processing_datestring date nullable

Next recurring charge date for recurring plan

organization_idinteger

ID of Organization receiving the recurring donation

pause_untilstring date nullable

This attribute indicates the date till the recurring donation plan is Paused

plan_paused_on_datestring date nullable

This attribute holds the date on which the recurring donation plan was Paused

payment_gatewaystring nullable

Payment processor. (Underlying payment processor for Classy Pay)

payment_provider_configuration_namestring nullable

The Recurring Donation Plan Payment Provider

payment_type'Credit Card' | 'ACH' | 'Paypal' nullable

Payment type of recurring

postal_codestring

Billing postal code

pp_plan_idstring

ID of the Payment provider

raw_currency_codestring

The currency code of the plan's transactions. Cannot be updated after being set

raw_donation_amountstring

The value donated, in the raw currency

recur_untilstring date nullable

Recurring plan end date

started_atstring date-time

Start time for recurring donations

statestring

Billing state

status'active' | 'attempted' | 'canceled' | 'draft' | 'failed' | 'failing' | 'ended' | 'paused'

Status of Recurring Donation Plan

supporter_idinteger nullable

ID of the Supporter that associates the Member and the Organization

timezone_identifierstring

Identifier of timezone against which recurring charges will be made

updated_atstring date-time

Last modification date

is_donor_covered_feeboolean

Flag if the rdp is a donor covered fee or not

raw_initial_gross_amountnumber float

Amount before any fee adjustments where added

raw_adjustment_amountnumber float

Total fee amount assessed

dcf_enabledboolean

Flag that indicate if the campaign has dcf enable

dcf_allowedboolean

Flag that indicate if the campaign is allowed to have dcf

classy_mode_enabledboolean

Flag that indicate if the campaign has classy mode enable

effective_fixed_fot_percentstring

Number of fixed fee on top percent

migratedboolean

Flag that indicates if the recurring plan is from a migration

migration_datestring date-time nullable

Date when migration was completed

Example response

{
  "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"
}