Import an account from a CRM

post

https://api.app.subskribe.com/accounts/crm/import

Ensures an account exists which matches the passed details.If an account exists that has a matching CRM Id, it will be updated, if not, it will be created

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

This is a system-generated Account ID

name

string

required

Account name

legalName

string

(optional) Account legal name

description

string

(optional) Account Description

phoneNumber

string

(optional) Phone number of the Account

crmId

string

(optional) CRM ID of the Account

crmType

string

(optional) CRM type

erpId

string

(optional) ERP ID of this account

externalId

string

(optional) External ID of this account

currency

string

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

string

enum

(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.

isReseller

boolean

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

hasAutomaticPayment

boolean

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

excludeFromBatchOperations

boolean

(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.

excludeFromDunning

boolean

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

supportedPaymentTypes

array of strings, unique

(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.

address

object

updatedOn

int64

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

customFields

object

(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.

entityIds

array of strings, unique

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

entityIds

Response

200successful operation