/recurrings.json

Creates a new recurring payment.

FieldDescriptionTypeMandatory
amountThe amountfloatyes
intervalRecurring intervalEnum (1, 3, 6, 12)yes
receipt_statusStatus of the donation receipt wishEnum ("receipt_now", "no_receipt", "receipt_end_of_year", "receipt_sent", "receipt_never")
typeType of the recurring paymentEnum ("recurring_membership", "recurring_sponsorship", "recurring_donation", "recurring_fine")yes
fb_person_idID of a person

(once set this value could not be changed by a PUT request any more)
integeryes
fb_source_idID of a sourceinteger
fb_project_idID of a projectinteger
fb_type_idID of a payment typeintegeryes
fb_sepa_mandate_idID of a mandatesintegerDepends on fb_type_id
fb_person_bank_account_idID of a bank accountintegerDepends on fb_type_id
start_dateStart date of the recurring paymentdate
next_payment_dateDate for the next paymentdateyes
end_dateAn optional enddatedate

📘

Custom fields

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

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