{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/recurrings.json","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\":223,\n    \"transaction_id\":\"\",\n    \"fb_transaction_id\":null,\n    \"fb_person_id\":501,\n    \"fb_payment_form_configuration_id\":null,\n    \"fb_source_id\":null,\n    \"source_name\":\"\",\n    \"source_promotion_code\":\"\",\n    \"fb_project_id\":null,\n    \"project_promotion_code\":\"\",\n    \"fb_type_id\":8,\n    \"type_promotion_code\":\"\",\n    \"meta_info\":{},\n    \"type\":\"recurring_donation\",\n    \"amount\":123,\n    \"currency\":\"EUR\",\n    \"interval\":6,\n    \"start_date\":\"2019-04-24\",\n    \"next_payment_date\":\"2019-04-25\",\n    \"end_date\":null,\n    \"receipt_status\":\"receipt_end_of_year\",\n    \"fb_person_bank_account_id\":null,\n    \"fb_person_credit_card_id\":null,\n    \"fb_sepa_mandate_id\":728,\n    \"created_at\":\"2019-04-24 14:07:42\",\n    \"updated_at\":\"2019-04-24 14:07:42\",\n    \"fb_custom_fields\":[]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n    \"fb_person_id\":501,\n    \"amount\":123,\n    \"interval\":6,\n    \"next_payment_date\":\"2019-04-25\",\n    \"type\":\"recurring_donation\",\n    \"fb_type_id\":8,\n    \"fb_sepa_mandate_id\":728\n}"}]},"method":"post","params":[]},"next":{"description":"","pages":[]},"title":"/recurrings.json","type":"endpoint","slug":"recurrings-create","excerpt":"Creates a new recurring payment.","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"11-0\": \"next_payment_date\",\n    \"12-0\": \"end_date\",\n    \"11-2\": \"date\",\n    \"12-2\": \"date\",\n    \"12-1\": \"An optional enddate\",\n    \"11-1\": \"Date for the next payment\",\n    \"h-3\": \"Mandatory\",\n    \"0-0\": \"amount\",\n    \"5-0\": \"fb_source_id\",\n    \"6-0\": \"fb_project_id\",\n    \"7-0\": \"fb_type_id\",\n    \"4-0\": \"fb_person_id\",\n    \"1-0\": \"interval\",\n    \"2-0\": \"receipt_status\",\n    \"3-0\": \"type\",\n    \"8-0\": \"fb_sepa_mandate_id\",\n    \"9-0\": \"fb_person_bank_account_id\",\n    \"10-0\": \"start_date\",\n    \"1-2\": \"Enum (1, 3, 6, 12)\",\n    \"1-1\": \"Recurring interval\",\n    \"0-2\": \"float\",\n    \"0-3\": \"yes\",\n    \"1-3\": \"yes\",\n    \"4-3\": \"yes\",\n    \"3-2\": \"Enum (\\\"recurring_membership\\\", \\\"recurring_sponsorship\\\", \\\"recurring_donation\\\", \\\"recurring_fine\\\")\",\n    \"4-2\": \"integer\",\n    \"5-2\": \"integer\",\n    \"6-2\": \"integer\",\n    \"7-2\": \"integer\",\n    \"8-2\": \"integer\",\n    \"9-2\": \"integer\",\n    \"10-2\": \"date\",\n    \"3-3\": \"yes\",\n    \"11-3\": \"yes\",\n    \"7-3\": \"yes\",\n    \"0-1\": \"The amount\",\n    \"3-1\": \"Type of the recurring payment\",\n    \"4-1\": \"ID of a [person](doc:persons-list)\\n\\n(once set this value could not be changed by a PUT request any more)\",\n    \"5-1\": \"ID of a [source](doc:sources-list)\",\n    \"6-1\": \"ID of a [project](doc:projects-list)\",\n    \"7-1\": \"ID of a [payment type](doc:types-list)\",\n    \"8-1\": \"ID of a [mandates](doc:mandates-list)\",\n    \"9-1\": \"ID of a [bank account](doc:personBankAccounts-show)\",\n    \"10-1\": \"Start date of the recurring payment\",\n    \"2-2\": \"Enum (\\\"receipt_now\\\", \\\"no_receipt\\\", \\\"receipt_end_of_year\\\", \\\"receipt_sent\\\", \\\"receipt_never\\\")\",\n    \"2-1\": \"Status of the donation receipt wish\",\n    \"8-3\": \"Depends on fb_type_id\",\n    \"9-3\": \"Depends on fb_type_id\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Custom fields\",\n  \"body\": \"Please find further information about custom fields [at the custom fields section](doc:custom-fields).\"\n}\n[/block]","updates":[],"order":57,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cc051b2dce80e0057f6c016","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-24T12:08:18.932Z","__v":0,"parentDoc":null}

post/recurrings.json

Creates a new recurring payment.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "11-0": "next_payment_date", "12-0": "end_date", "11-2": "date", "12-2": "date", "12-1": "An optional enddate", "11-1": "Date for the next payment", "h-3": "Mandatory", "0-0": "amount", "5-0": "fb_source_id", "6-0": "fb_project_id", "7-0": "fb_type_id", "4-0": "fb_person_id", "1-0": "interval", "2-0": "receipt_status", "3-0": "type", "8-0": "fb_sepa_mandate_id", "9-0": "fb_person_bank_account_id", "10-0": "start_date", "1-2": "Enum (1, 3, 6, 12)", "1-1": "Recurring interval", "0-2": "float", "0-3": "yes", "1-3": "yes", "4-3": "yes", "3-2": "Enum (\"recurring_membership\", \"recurring_sponsorship\", \"recurring_donation\", \"recurring_fine\")", "4-2": "integer", "5-2": "integer", "6-2": "integer", "7-2": "integer", "8-2": "integer", "9-2": "integer", "10-2": "date", "3-3": "yes", "11-3": "yes", "7-3": "yes", "0-1": "The amount", "3-1": "Type of the recurring payment", "4-1": "ID of a [person](doc:persons-list)\n\n(once set this value could not be changed by a PUT request any more)", "5-1": "ID of a [source](doc:sources-list)", "6-1": "ID of a [project](doc:projects-list)", "7-1": "ID of a [payment type](doc:types-list)", "8-1": "ID of a [mandates](doc:mandates-list)", "9-1": "ID of a [bank account](doc:personBankAccounts-show)", "10-1": "Start date of the recurring payment", "2-2": "Enum (\"receipt_now\", \"no_receipt\", \"receipt_end_of_year\", \"receipt_sent\", \"receipt_never\")", "2-1": "Status of the donation receipt wish", "8-3": "Depends on fb_type_id", "9-3": "Depends on fb_type_id" }, "cols": 4, "rows": 13 } [/block] [block:callout] { "type": "info", "title": "Custom fields", "body": "Please find further information about custom fields [at the custom fields section](doc:custom-fields)." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}