Create Account

post

https://{subdomain}.{domain}/v2/accounts

Creates a new account. You may optionally include billing information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_code

string

required

A unique identifier used by your application to identify the account. This code may only contain the following characters: [a-z 0-9 @ - _ .] but it may not begin with a dot or hyphen character. Max of 50 characters.

parent_account_code

string

The account code of the new parent account. Allows associating a new account to an existing account as its child.

bill_to

string

Defaults to self

self or parent. Determines whether all charges are billed using parent's billing information or the account itself. If bill_to = parent, all invoices resulting in charges and credits originating from a child will be created on the parent account. (e.g creating a subscription on the child account will be billed to parent and invoiced on the parent account)

username

string

The username for the account, ignore if you do not use usernames. Max of 255 characters.

string

The email address for the account.

first_name

string

The first name for the account. Max of 255 characters.

last_name

string

The last name for the account. Max of 255 characters.

company_name

string

The company name for the account. Max of 50 characters.

vat_number

string

The VAT number to avoid having the VAT applied (if applicable).

tax_exempt

boolean

The tax status for the account.

exemption_certificate

string

Optional field for merchants taxing through Vertex. String of 1-30 characters. If an exemption_certificate is provided, tax_exempt must be true.

entity_use_code

string

The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.

account_acquisition

object

The nested account acquisition information: cost_in_cents, currency, channel, subchannel, campaign

billing_info

object

The nested billing information. If present, the account will only be created after the billing information is validated.

address

object

The nested address information for the account: address1, address2, city, state, zip, country, phone.

shipping_address

object

The nested shipping address information of the account: first_name, last_name, company_name, email, phone, vat_number, address1, address2, city, state, zip, country, nickname. You can pass in up to 20 account shipping addresses along with the request to create a new account. When providing a shipping address, the following are required: first_name, last_name, address1, city, state, zip, and country.

accept_language

string

The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.

cc_emails

string

Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the email field also receives.

preferred_locale

string

Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.

preferred_time_zone

string

Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a supported IANA time zone name

transaction_type

string

Indicates type of resulting transaction. accepted_values: "moto".

invoice_template_uuid

string

Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify which invoice template, if any, should be used to generate invoices for the account.

dunning_campaign_id

string

Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

override_business_entity_id

string

Unique ID to identify the business entity assigned to the account. Available when the Multiple Business Entities feature is enabled.

custom_fields

array of objects

The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Custom Fields

external_accounts

object

The nested external_account information. external_account_code, external_connection_type

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/xml

201