The Account Object - Vindicia Subscribe — SaaS Knowledge Center

Attributes

Name	Type	Description
object	string	Value is “Account”
id	string	A merchant-specified unique identifier. If not specified, this object can be identified by its vid.
vid	string	A Globally Unique Identifier (GUID) for this object. Assigned by Subscribe.
created	datetime	The datetime the Account was created. Read only.
external_id	string	An additional merchant-specified unique identifier for when you have two external (non-Subscribe) systems using two different identification schemes for the same customer. It can be used in place of vid or id
parent	Accounts	The parent Account object id or vid of this Account.
default_currency	string	The currency used on subscriptions and transactions belonging to this Account when not explicitly specified. An ISO 4217 Currency Code.
email	string	The email address associated with this Account.
email_type	enum	The email format type preferred by this customer. Values can be `html`, `multipart`, `plaintext`
language	string	The language (code) preferred for communications.
notify_before_billing	boolean	Whether or not to send this customer pre-billing notification (emails).
company	string	The company name of the customer if a business Account.
name	string	The name of the person primarily associated with this Account.
shipping_address	Address	The primary physical address associated with this Account.
payment_methods	Payment Method	The payment methods on file for this Account.
metadata	hash	A set of key/value pairs that you can attach to an object. Useful for storing additional information. For more details, see Metadata.
tax_exemptions	Tax Exemption	Tax Exemptions registered for this Account.
tokens	Token Amount	The token balances for this Account.
credit	Credit	The account-level credit balances for this Account.
entitlements	Entitlement	The account-level entitlements for this Account.
tax_use_code	string	Special Tax Handling rules defined with merchant’s tax service.

Example Object

{
    "object": "Account",
    "id": "cust_1234", 
    “external_id”: “Ext_12345",
    "vid": "f147870b2c86a00fb1264fb64c0a8b58fcd95b4d",
    "created": "2020-05-18T13:39:03-07:00",
    "default_currency": "USD",
    "email": "cbrown@example.com",
    "email_type": "html",
    "language": "EN-U",
    "notify_before_billing": true,
    "company": "Peanuts",
    "name": "Charlie Brown",
    "shipping_address": {
        "object": "Address",
        "vid": "dad524f59d1bd72f10a9162b7d7790caa39678dc",
        "name": "Charlie Brown",
        "line1": "123 Main Street",
        "city": "San Francisco",
        "district": "CA",
        "postal_code": "94105",
        "country": "US",
        "phone": "415-555-3212"
    },
    "metadata": {
        "favorite dog": "Snoopy",
        "favorite activity": "flying kites"
    }
}

Parent topic:Accounts