curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"c3991297470e6b882d3c5976e567d57f2c532dc5\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children"
payload = "{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"c3991297470e6b882d3c5976e567d57f2c532dc5\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "object": "Account", "id": "cust_child_2234", "external_id": "Ext_child_12345", "default_currency": "USD", "email": "dbrown@example.com", "email_type": "html", "language": "EN-U", "notify_before_billing": true, "company": "Peanuts", "name": "David Brown", "shipping_address": { "object": "Address", "vid": "c3991297470e6b882d3c5976e567d57f2c532dc5", "name": "David Brown", "line1": "123 Main Street", "city": "San Francisco", "district": "CA", "postal_code": "94105", "country": "US", "phone": "415-555-3212" }, "metadata": { "favorite dog": "Scooby", "favorite activity": "Swimming" } }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('{ "object": "Account", "id": "cust_child_2234", "external_id": "Ext_child_12345", "default_currency": "USD", "email": "dbrown@example.com", "email_type": "html", "language": "EN-U", "notify_before_billing": true, "company": "Peanuts", "name": "David Brown", "shipping_address": { "object": "Address", "vid": "c3991297470e6b882d3c5976e567d57f2c532dc5", "name": "David Brown", "line1": "123 Main Street", "city": "San Francisco", "district": "CA", "postal_code": "94105", "country": "US", "phone": "415-555-3212" }, "metadata": { "favorite dog": "Scooby", "favorite activity": "Swimming" } }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children"
payload := strings.NewReader("\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"vid\": \"872d09b4e67d17dcc566ed8d51a529eeb6777727\", \"created\": \"2022-04-07T10:04:32+00:00\", \"parent\": { \"object\": \"Account\", \"id\": \"cust_2234\", \"vid\": \"04dbe59a1b72c653b672f828565b4989c2a9ac47\" }, \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"e705932f5362ee809910d45a3305332f788c985b\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Add child account
Subscribe supports two-level account hierarchies for payment and reporting; that is, you may define parent and children accounts. A parent can have multiple children, but a child may have only one parent, and a child may not be a parent to another Account.
A parent can pay for its own Subscriptions or one-time transactions, or for any of its children’s Subscriptions or one-time transactions. (This is handled by allowing a parent’s Payment Method to be on an Subscription with the child’s Account.)
Children may have Payment Methods that differ from their Parent’s, and may use either theirs or their parent’s to pay for their Subscriptions.
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"c3991297470e6b882d3c5976e567d57f2c532dc5\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children"
payload = "{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"c3991297470e6b882d3c5976e567d57f2c532dc5\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('{ "object": "Account", "id": "cust_child_2234", "external_id": "Ext_child_12345", "default_currency": "USD", "email": "dbrown@example.com", "email_type": "html", "language": "EN-U", "notify_before_billing": true, "company": "Peanuts", "name": "David Brown", "shipping_address": { "object": "Address", "vid": "c3991297470e6b882d3c5976e567d57f2c532dc5", "name": "David Brown", "line1": "123 Main Street", "city": "San Francisco", "district": "CA", "postal_code": "94105", "country": "US", "phone": "415-555-3212" }, "metadata": { "favorite dog": "Scooby", "favorite activity": "Swimming" } }')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('{ "object": "Account", "id": "cust_child_2234", "external_id": "Ext_child_12345", "default_currency": "USD", "email": "dbrown@example.com", "email_type": "html", "language": "EN-U", "notify_before_billing": true, "company": "Peanuts", "name": "David Brown", "shipping_address": { "object": "Address", "vid": "c3991297470e6b882d3c5976e567d57f2c532dc5", "name": "David Brown", "line1": "123 Main Street", "city": "San Francisco", "district": "CA", "postal_code": "94105", "country": "US", "phone": "415-555-3212" }, "metadata": { "favorite dog": "Scooby", "favorite activity": "Swimming" } }'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children"
payload := strings.NewReader("\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/accounts/{ID}/children")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"{ \\\"object\\\": \\\"Account\\\", \\\"id\\\": \\\"cust_child_2234\\\", \\\"external_id\\\": \\\"Ext_child_12345\\\", \\\"default_currency\\\": \\\"USD\\\", \\\"email\\\": \\\"dbrown@example.com\\\", \\\"email_type\\\": \\\"html\\\", \\\"language\\\": \\\"EN-U\\\", \\\"notify_before_billing\\\": true, \\\"company\\\": \\\"Peanuts\\\", \\\"name\\\": \\\"David Brown\\\", \\\"shipping_address\\\": { \\\"object\\\": \\\"Address\\\", \\\"vid\\\": \\\"c3991297470e6b882d3c5976e567d57f2c532dc5\\\", \\\"name\\\": \\\"David Brown\\\", \\\"line1\\\": \\\"123 Main Street\\\", \\\"city\\\": \\\"San Francisco\\\", \\\"district\\\": \\\"CA\\\", \\\"postal_code\\\": \\\"94105\\\", \\\"country\\\": \\\"US\\\", \\\"phone\\\": \\\"415-555-3212\\\" }, \\\"metadata\\\": { \\\"favorite dog\\\": \\\"Scooby\\\", \\\"favorite activity\\\": \\\"Swimming\\\" } }\""
response = http.request(request)
puts response.read_body"{ \"object\": \"Account\", \"id\": \"cust_child_2234\", \"external_id\": \"Ext_child_12345\", \"vid\": \"872d09b4e67d17dcc566ed8d51a529eeb6777727\", \"created\": \"2022-04-07T10:04:32+00:00\", \"parent\": { \"object\": \"Account\", \"id\": \"cust_2234\", \"vid\": \"04dbe59a1b72c653b672f828565b4989c2a9ac47\" }, \"default_currency\": \"USD\", \"email\": \"dbrown@example.com\", \"email_type\": \"html\", \"language\": \"EN-U\", \"notify_before_billing\": true, \"company\": \"Peanuts\", \"name\": \"David Brown\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"e705932f5362ee809910d45a3305332f788c985b\", \"name\": \"David Brown\", \"line1\": \"123 Main Street\", \"city\": \"San Francisco\", \"district\": \"CA\", \"postal_code\": \"94105\", \"country\": \"US\", \"phone\": \"415-555-3212\" }, \"metadata\": { \"favorite dog\": \"Scooby\", \"favorite activity\": \"Swimming\" } }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The id or the vid of the Account to add a child account A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128Query Parameters
Force will override any existing parent accounts of the child account
Can be ReplaceOnAllAutoBills, ReplaceOnlyFutureAutoBills
ReplaceOnAllAutoBills, ReplaceOnlyFutureAutoBills Body
JSON - A new or existing Account.
The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide
An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.
An Account owns the “on file” payment methods to be used by it in billing.
Value is “Account”
Account A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128The name of the person primarily associated with this Account.
A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
128An additional merchant-specified unique identifier for when you have two external (non-CashBox) systems using two different identification schemes for the same customer. It can be used in place of vid or i
The date/time the Account was created.
The parent (Account) id or vid of this Account
The email address associated with this Account.
The email format type preferred by this customer.
html, multipart, plaintext The language (code) preferred for communications.
Whether or not to send this customer pre-billing notification (emails).
The company name of the customer if a business Account.
The Address object represents a physical or mailing address.
Show child attributes
Show child attributes
The payment methods on file for this Account.
Show child attributes
Show child attributes
Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.
The metadata field supports key-value pairs with the following limitations:
Keys can be up to 256 characters
Keys can be any string that is needed, except only CashBox can prefix keys with vin:
Values can be up to 1024 characters
In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.
Tax Exemptions registered for this Account.
Show child attributes
Show child attributes
The token balances for this Account.
Show child attributes
Show child attributes
The account-level credit balances for this Account.
Show child attributes
Show child attributes
The account-level entitlements for this Account.
Show child attributes
Show child attributes
Special Tax Handling rules defined with CSP’s tax service.
Response
JSON - An Account object.
The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide
An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.
An Account owns the “on file” payment methods to be used by it in billing.
Value is “Account”
Account A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
128The name of the person primarily associated with this Account.
A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
128An additional merchant-specified unique identifier for when you have two external (non-CashBox) systems using two different identification schemes for the same customer. It can be used in place of vid or i
The date/time the Account was created.
The parent (Account) id or vid of this Account
The email address associated with this Account.
The email format type preferred by this customer.
html, multipart, plaintext The language (code) preferred for communications.
Whether or not to send this customer pre-billing notification (emails).
The company name of the customer if a business Account.
The Address object represents a physical or mailing address.
Show child attributes
Show child attributes
The payment methods on file for this Account.
Show child attributes
Show child attributes
Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.
The metadata field supports key-value pairs with the following limitations:
Keys can be up to 256 characters
Keys can be any string that is needed, except only CashBox can prefix keys with vin:
Values can be up to 1024 characters
In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.
Tax Exemptions registered for this Account.
Show child attributes
Show child attributes
The token balances for this Account.
Show child attributes
Show child attributes
The account-level credit balances for this Account.
Show child attributes
Show child attributes
The account-level entitlements for this Account.
Show child attributes
Show child attributes
Special Tax Handling rules defined with CSP’s tax service.