{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/billing/subscriptions/:id/payments","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\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  \"payments\": [\n    {\n      \"id\": 2,\n      \"email\": \"lorem:::at:::ipsum.com\",\n      \"title\": \"Payment\",\n      \"payment_method\": \"instant\",\n      \"due_days_period\": null,\n      \"status\": \"pending\",\n      \"data\": {\n        \"id\": 2,\n        \"billing_subscribers_id\": 2,\n        \"billing_details_id\": 2,\n        \"merchant_subscription_id\": \"MERC-SUBSCRIPTION-ID-1\",\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        \"deleted_at\": null,\n        \"entity_type\": \"Business\",\n        \"entity_id\": 16,\n        \"created_at\": \"2022-03-25T08:32:30.000Z\",\n        \"updated_at\": \"2022-03-25T08:32:30.000Z\",\n        \"send_payment_email\": false,\n        \"subscriber\": {\n          \"id\": 2,\n          \"entity_type\": \"Business\",\n          \"entity_id\": 16,\n          \"email\": \"[email protected]\",\n          \"merchant_subscriber_id\": \"MERC-SUBS-ID-1\",\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          \"deleted_at\": null,\n          \"created_at\": \"2022-03-25T08:32:30.000Z\",\n          \"updated_at\": \"2022-03-25T08:32:30.000Z\"\n        },\n        \"details\": {\n          \"id\": 2,\n          \"entity_type\": \"Business\",\n          \"entity_id\": 16,\n          \"title\": \"Some Hosting Company\",\n          \"description\": \"Your purchase at Some Hosting Company\",\n          \"send_paid_notification\": false,\n          \"payment_method\": \"instant\",\n          \"price_currency_id\": 2,\n          \"deleted_at\": null,\n          \"merchant_details_id\": \"MERC-DETA-ID-1\",\n          \"receive_currency_id\": 6,\n          \"callback_url\": \"https://yourcallbackurl.com/callbacks\",\n          \"main_currencies\": null,\n          \"enabled_main_sorting\": null,\n          \"do_not_convert\": null,\n          \"disabled_at\": null,\n          \"send_payment_email\": null,\n          \"created_at\": \"2022-03-25T08:32:30.000Z\",\n          \"updated_at\": \"2022-03-25T08:32:30.000Z\",\n          \"underpaid_cover_pct\": \"0.0\",\n          \"items\": [\n            {\n              \"id\": 2,\n              \"billing_details_id\": 2,\n              \"merchant_item_id\": \"MERC-ITEM-ID-1\",\n              \"description\": \"Smaller server\",\n              \"quantity\": 1,\n              \"price\": \"50.0\"\n            }\n          ]\n        }\n      },\n      \"paid_at\": null,\n      \"price_amount\": \"50.0\",\n      \"subscription_id\": 2,\n      \"payment_url\": \"https://pay.coingate.com/invoice/b8d68eee-aa21-478e-bc15-d8251c9dc12e\",\n      \"price_currency\": \"EUR\",\n      \"receive_currency\": \"LTC\"\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n\t\"message\": \"Billing subscription not found\",\n\t\"reason\": \"BillingSubscriptionNotFound\"\n}","language":"json","status":404}]},"params":[{"name":"id","type":"int","default":"","desc":"ID of subscription","required":true,"in":"path","ref":"","_id":"5e8307ccf99e2500682abaa4"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get Subscription Payments","type":"endpoint","slug":"get-subscription-payments","excerpt":"Retrieves all payments associated with a specific subscription.\n\nBefore making a <b>GET Subscription Payments</b> request, a [POST Create Subscription](doc:create-subscription) request should be made. \n\nAfter a subscription is created, you will get the subscription ID which will be used in the <b>GET Subscription Payments</b> request.\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":["5edc951ba376960022c866e8","5eded2c4466a38001e8dd875","5ee02b53d35a04002fc7eb99","5ee3bcb26369eb0038c57952","5ee55160345ca500591b8df2","5ee5516b6b4aaf00211f9ef0"],"order":19,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e8308899ca2b60039e32f3a","createdAt":"2020-03-31T09:08:25.454Z","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":12,"parentDoc":null}

getGet Subscription Payments

Retrieves all payments associated with a specific subscription. Before making a <b>GET Subscription Payments</b> request, a [POST Create Subscription](doc:create-subscription) request should be made. After a subscription is created, you will get the subscription ID which will be used in the <b>GET Subscription Payments</b> request. ❗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

Path Params

id:
required
integer
ID of subscription

Result Format