{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/recurrings/:id.json","auth":"required","settings":"","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"id\":219,\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-23\",\n    \"next_payment_date\":\"2019-04-24\",\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\":716,\n    \"created_at\":\"2019-04-23 14:21:12\",\n    \"updated_at\":\"2019-04-23 14:21:12\",\n    \"fb_custom_fields\":[\n        {\n            \"id\":7,\n            \"name\":\"Favorite color\",\n            \"value\":\"red\"\n        },\n        {\n            \"id\":10,\n            \"name\":\"Special date\",\n            \"value\":\"1978-05-22\"\n        }\n    ]\n}"}]},"method":"get","examples":{"codes":[]},"params":[{"name":"id","type":"int","default":"","desc":"Recurring payment ID","required":true,"in":"path","ref":"","_id":"571f9a30ee9c2124004b3e16"}]},"next":{"description":"","pages":[]},"title":"/recurrings/:id.json","type":"endpoint","slug":"recurrings-show","excerpt":"Returns a single recurring payment.","body":"Shows a single recurring payment with a given ID.\n[block:api-header]\n{\n  \"title\": \"Enum values\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Possible values\",\n    \"0-0\": \"**type**\",\n    \"1-0\": \"**receipt_status**\",\n    \"0-1\": \"recurring_membership\\nrecurring_sponsorship\\nrecurring_donation\\nrecurring_fine\",\n    \"1-1\": \"pending\\nactive\\ncancelled\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\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]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Meta infos\",\n  \"body\": \"The data could offer some so called \\\"meta infos\\\". These meta info can contain some useful additional informations. Please take a look [at the meta-info section](doc:meta-info) for more details.\"\n}\n[/block]","updates":[],"order":56,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbf038cace26900161e409a","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-23T12:22:36.635Z","__v":10,"parentDoc":null}

get/recurrings/:id.json

Returns a single recurring payment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Recurring payment ID

Result Format


Documentation

Shows a single recurring payment with a given ID. [block:api-header] { "title": "Enum values" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Possible values", "0-0": "**type**", "1-0": "**receipt_status**", "0-1": "recurring_membership\nrecurring_sponsorship\nrecurring_donation\nrecurring_fine", "1-1": "pending\nactive\ncancelled" }, "cols": 2, "rows": 2 } [/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] [block:callout] { "type": "info", "title": "Meta infos", "body": "The data could offer some so called \"meta infos\". These meta info can contain some useful additional informations. Please take a look [at the meta-info section](doc:meta-info) for more details." } [/block]

User Information

Try It Out

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