{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/billing/subscriptions","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"current_page\": 1,\n  \"per_page\": 100,\n  \"total_subscriptions\": 1,\n  \"total_pages\": 1,\n  \"subscriptions\": [\n    {\n      \"id\": 2,\n      \"status\": \"completed\",\n      \"start_date\": \"2022-03-25\",\n      \"end_date\": \"2022-03-25\",\n      \"next_delivery_date\": null,\n      \"due_days_period\": null,\n      \"created_at\": \"2022-03-25T08:32:30.000Z\",\n      \"subscription_id\": \"SUB-3\",\n      \"details\": {\n        \"id\": 85,\n        \"send_paid_notification\": true,\n        \"send_payment_email\": null,\n        \"title\": \"Some Hosting Company\",\n        \"description\": \"Your purchase at Some Hosting Company\",\n        \"payment_method\": \"instant\",\n        \"callback_url\": \"https://yourcallbackurl.com/callbacks\",\n        \"underpaid_cover_pct\": \"0.0\",\n        \"details_id\": \"301\",\n        \"price_currency\": \"EUR\",\n        \"receive_currency\": \"BTC\",\n        \"items\": [\n          {\n            \"id\": 139,\n            \"description\": \"Very big server\",\n            \"quantity\": 1,\n            \"price\": \"10.8\",\n            \"item_id\": \"401\"\n          }\n        ]\n      },\n      \"subscriber\": {\n        \"id\": 128,\n        \"email\": \"lorem:::at:::ipsum.com\",\n        \"organisation_name\": \"\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Smith\",\n        \"address\": \"New N Rd, Islington\",\n        \"secondary_address\": null,\n        \"city\": \"London\",\n        \"postal_code\": \"N18SY\",\n        \"country\": \"United Kingdom\",\n        \"subscriber_id\": null\n      }\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n\t\"message\": \"Auth Token is not valid\",\n\t\"reason\": \"BadAuthToken\"\n}","language":"json","status":401}]},"params":[{"name":"page","type":"int","default":"1","desc":"Current page number","required":false,"in":"body","ref":"","_id":"627a7f9681ead2007c7b2896"},{"name":"per_page","type":"int","default":"100","desc":"Number of subscriptions per page (max - 100)","required":false,"in":"body","ref":"","_id":"627a7f9681ead2007c7b2897"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get Subscriptions","type":"endpoint","slug":"get-subscriptions","excerpt":"Retrieves all subscriptions.\n\n❗To create requests within the CoinGate system the user should have an authentication token. To get it, please follow the instructions <a href=\"https://developer.coingate.com/docs/api-authentication\" target=\"_blank\">here</a>.","body":"","updates":[],"order":13,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7b563b768565006cd3c3be","createdAt":"2020-03-25T13:01:47.840Z","user":"5530bf7457cea10d00a3aa3a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Billing","slug":"billing","order":6,"from_sync":false,"reference":false,"_id":"5e7b51281ac49702d745882c","createdAt":"2020-03-25T12:40:08.657Z","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","__v":0},"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b","5e7b51281ac49702d745882c","5e7b526560c6cc004f25ca3e","61c47c8dc69d6b000f961812","62289a8cb831c9003650b36c","62615ded4828c0003015b8a2","627511250a8fbb052a794d80","62b43cee767dd2003ad59e14"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":10},"project":"5530bfac57cea10d00a3aa3b","__v":10,"parentDoc":null}

getGet Subscriptions

Retrieves all subscriptions. ❗To create requests within the CoinGate system the user should have an authentication token. To get it, please follow the instructions <a href="https://developer.coingate.com/docs/api-authentication" target="_blank">here</a>.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

page:
integer1
Current page number
per_page:
integer100
Number of subscriptions per page (max - 100)

Result Format