{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/billing/subscribers","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n    \"email\": \"lorem:::at:::ipsum.com\",\n    \"subscriber_id\": \"USER-123\",\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}","language":"json","status":200}]},"params":[{"name":"email","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5f"},{"name":"subscriber_id","type":"int","default":"","desc":"Subscriber ID that is used in your application (e.g. user or customer id).","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5e"},{"name":"organisation_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5d"},{"name":"first_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5c"},{"name":"last_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5b"},{"name":"address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f5a"},{"name":"secondary_address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f59"},{"name":"city","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f58"},{"name":"postal_code","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f57"},{"name":"country","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b80e8e6b1cc03caaf1f56"}],"examples":{"codes":[{"code":"curl --location --request POST 'https://sandbox.coingate.com/api/v2/billing/subscribers/' \\\n--header 'Authorization: Bearer YOUR_TOKEN_GOES_HERE' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"[email protected]\",\n    \"subscriber_id\": \"USER-123\",\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}'","language":"curl"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create subscriber","type":"endpoint","slug":"create-subscriber","excerpt":"Creates a subscriber to whom specific subscriptions and subscription details will be assigned later on. Subscriber represents a natural or legal entity. In other words, your user or customer.","body":"All parameters except `email` are optional.\n\nSubscriber ID posted is intended to be used as an identifier used to identify a user on your application and should not be confused with `id` parameter returned in a response when creating a subscriber. The latter is a fixed identifier used by CoinGate.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7b51e118a4450041b421c1","createdAt":"2020-03-25T12:43:13.360Z","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":9,"parentDoc":null}

postCreate subscriber

Creates a subscriber to whom specific subscriptions and subscription details will be assigned later on. Subscriber represents a natural or legal entity. In other words, your user or customer.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
required
string
subscriber_id:
integer
Subscriber ID that is used in your application (e.g. user or customer id).
organisation_name:
string
first_name:
string
last_name:
string
address:
string
secondary_address:
string
city:
string
postal_code:
string
country:
string

Examples


Result Format


Documentation

All parameters except `email` are optional. Subscriber ID posted is intended to be used as an identifier used to identify a user on your application and should not be confused with `id` parameter returned in a response when creating a subscriber. The latter is a fixed identifier used by CoinGate.