{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/billing/details","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n    \"id\": 85,\n    \"send_paid_notification\": true,\n    \"title\": \"Some Hosting Company\",\n    \"description\": \"Your purchase at Some Hosting Company\",\n    \"payment_method\": \"instant\",\n    \"callback_url\": \"https://yourcallbackurl.com\",\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            \"id\": 140,\n            \"description\": \"Smaller server\",\n            \"quantity\": 2,\n            \"price\": \"10.8\",\n            \"item_id\": \"401\"\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{\"message\":\"Ooops! We're sorry, but something went wrong. We've been notified about this issue and we'll take a look at it shortly.\",\"reason\":\"InternalServerError\"}","language":"json","status":400}]},"params":[{"name":"title","type":"string","default":"","desc":"If used, will be displayed to a user on an actual bill.","required":false,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a49b"},{"name":"description","type":"string","default":"","desc":"If used, will be displayed to a user on an actual bill.","required":false,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a49a"},{"name":"payment_method","type":"string","default":"","desc":"Accepted values: instant, weekly, monthly, quarterly, yearly","required":true,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a498"},{"name":"price_currency","type":"string","default":"","desc":"ISO symbol of a currency in which items sold are valued on system.","required":true,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a497"},{"name":"send_paid_notification","type":"boolean","default":"","desc":"Notification about each bill successfully paid will be sent to your email.","required":false,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a496"},{"name":"details_id","type":"string","default":"","desc":"Internal id used in your system.","required":false,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a495"},{"name":"items","type":"string","default":"","desc":"A list of items, their quantity and price.","required":false,"in":"body","ref":"","_id":"5e7b8575b4e99b003036a494"}],"examples":{"codes":[{"code":"curl --location --request POST 'https://sandbox.coingate.com/api/v2/billing/details' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer YOUR_TOKEN_GOES_HERE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\t\"title\": \"Some Hosting Company\",\n\t\"description\": \"Your purchase at Some Hosting Company\",\n\t\"price_currency\": \"EUR\",\n\t\"payment_method\": \"instant\",\n\t\"send_paid_notification\": \"true\",\n\t\"details_id\": \"301\",\n\t\"items\": [\n\t\t{\n\t\t\t\"item_id\": \"401\",\n\t\t\t\"description\": \"Very big server\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"price\": 10.80\n\t\t},\n\t\t{\n\t\t\t\"item_id\": \"401\",\n\t\t\t\"description\": \"Smaller server\",\n\t\t\t\"quantity\": 2,\n\t\t\t\"price\": 10.80\n\t\t}\n\t],\n \t\"callback_url\": \"https://yourcallbackurl.com\",\n \t\"receive_currency\": \"BTC\"\n}\n","language":"curl"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create subscription details","type":"endpoint","slug":"create-billing-details","excerpt":"Subscription details stores all the key parameters of a single bill.","body":"","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7b53e2d7325d02fcc291b6","createdAt":"2020-03-25T12:51:46.084Z","user":"5530bf7457cea10d00a3aa3a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Billing","slug":"billing","order":3,"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"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":5},"project":"5530bfac57cea10d00a3aa3b","__v":12,"parentDoc":null}

postCreate subscription details

Subscription details stores all the key parameters of a single bill.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

title:
string
If used, will be displayed to a user on an actual bill.
description:
string
If used, will be displayed to a user on an actual bill.
payment_method:
required
string
Accepted values: instant, weekly, monthly, quarterly, yearly
price_currency:
required
string
ISO symbol of a currency in which items sold are valued on system.
send_paid_notification:
boolean
Notification about each bill successfully paid will be sent to your email.
details_id:
string
Internal id used in your system.
items:
string
A list of items, their quantity and price.

Examples


Result Format