{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/billing/subscribers/:id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\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\": \"Manchester\",\n    \"postal_code\": \"N18SY\",\n    \"country\": \"United Kingdom\",\n    \"subscriber_id\": null\n}","language":"json","status":200}]},"params":[{"name":"id","type":"int","default":"","desc":"Subscriber ID assigned by CoinGate and returned in a response.","required":true,"in":"path","ref":"","_id":"5e7b83dc2831b0035098ff38"},{"name":"email","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba556"},{"name":"subscriber_id","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba555"},{"name":"organisation_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba554"},{"name":"first_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba553"},{"name":"last_name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba552"},{"name":"address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba551"},{"name":"secondary_address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba550"},{"name":"city","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba54f"},{"name":"postal_code","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba54e"},{"name":"country","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5e7b844894bf9f002f3ba54d"}],"examples":{"codes":[{"code":"curl --location --request PATCH 'https://sandbox.coingate.com/api/v2/billing/subscribers/128' \\\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\": \"Manchester\",\n    \"postal_code\": \"N18SY\",\n    \"country\": \"United Kingdom\",\n    \"subscriber_id\": null\n}'","language":"curl"}]},"method":"patch"},"next":{"description":"","pages":[]},"title":"Edit subscriber","type":"endpoint","slug":"edit-subscriber","excerpt":"Updates information of a specific subscriber.","body":"Use same body parameters as in a POST request.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7b528b153be801db3eb93b","createdAt":"2020-03-25T12:46:03.317Z","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":7,"parentDoc":null}

patchEdit subscriber

Updates information of a specific subscriber.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Subscriber ID assigned by CoinGate and returned in a response.

Body Params

email:
required
string
subscriber_id:
string
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

Use same body parameters as in a POST request.