v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB

Accounts

Get an account by id

Retrieves detailed information about a specific account using its unique identifier. It could be Account_ID, CRM_ID or External_ID. This endpoint provides comprehensive data for a particular account, enabling users to access full account details.

get/accounts/{id}

Path parameters

idstring required

Uniquely identifies the Account

Query parameters

idType'ACCOUNT_ID' | 'CRM_ID' | 'EXTERNAL_ID'

Specifies the type of ID being used. Allowed values are account_id: The default account ID. crm_id: The CRM (Customer Relationship Management) ID external_id: An external system's ID for the account. Default is account_id

Response

successful operation

idstring

This is a system-generated Account ID

namestring required

Account name

legalNamestring

(optional) Account legal name

descriptionstring

(optional) Account Description

phoneNumberstring

(optional) Phone number of the Account

timezonestring

crmIdstring

(optional) CRM ID of the Account

crmTypestring

(optional) CRM type

erpIdstring

(optional) ERP ID of this account

externalIdstring

(optional) External ID of this account

currencystring

The currency code (ISO 4217 format). If currency is not entered, USD will be applied by default. Possible currencies in Subskribe: AED AUD CAD CHF CZK DKK EUR GBP HKD INR MXN NOK NZD SAR SEK SGD TWD USD

taxExemptionUseCode'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'P' | 'Q' | 'R'

(optional) Indicates Tax Exemption Information. When the account does not qualify for Tax Exemption, add null in the request. When using Anrok Tax Integration, keep this value null , as Anrok requires to upload Tax Exemption Certificate.

isResellerboolean

(optional) Input true, if this is a Reseller Account. Default is false

hasAutomaticPaymentboolean

(optional) Input true, if this Account will have an automatic payment. Default is false

excludeFromBatchOperationsboolean

(optional) Input true, if this account needs to be excluded from Batch Operations like Bulk Invoice Run, Invoice Generation. Default is false. This is an optional field.

excludeFromDunningboolean

(optional) Input true, if this account needs to be excluded from Dunning emails. Default is false. This is an optional field.

supportedPaymentTypesstring[]

(optional) Supported payment types for this Account. This field can include various payment types such as ACH, Card, Check, Wire, and Invoice. This is an optional field.

updatedOninteger

(optional) will be auto-populated as today's date

customFieldsobject

(optional) Use this option to create custom fields for the Account object if you need to collect Account-specific information, such as region, age, or gender.

entityIdsstring[]

(optional) Enter the entity ID where this Account belongs to