/recurrings.json

Creates a new recurring payment.

Field

Description

Type

Mandatory

amount

The amount

float

yes

interval

Recurring interval

Enum (1, 3, 6, 12)

yes

receipt_status

Status of the donation receipt wish

Enum ("receipt_now", "no_receipt", "receipt_end_of_year", "receipt_sent", "receipt_never")

type

Type of the recurring payment

Enum ("recurring_membership", "recurring_sponsorship", "recurring_donation", "recurring_fine")

yes

fb_person_id

ID of a person

(once set this value could not be changed by a PUT request any more)

integer

yes

fb_source_id

ID of a source

integer

fb_project_id

ID of a project

integer

fb_type_id

ID of a payment type

integer

yes

fb_sepa_mandate_id

ID of a mandates

integer

Depends on fb_type_id

fb_person_bank_account_id

ID of a bank account

integer

Depends on fb_type_id

start_date

Start date of the recurring payment

date

next_payment_date

Date for the next payment

date

yes

end_date

An optional enddate

date

📘

Custom fields

Please find further information about custom fields at the custom fields section.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!