Create an account

Creates a new account object.

Request
query Parameters
expand[]
Array of strings

Allows you to expand responses by including related object information in a single call. See the 'Expand responses' section of the Quickstart API Tutorial for detailed instructions.

header Parameters
zuora-track-id
string

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote (').

async
boolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

zuora-entity-id
string

An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.

idempotency-key
string

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encoding
string

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encoding
string

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

Request Body schema: application/json
object (CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

account_number
string

Human-readable identifier of the account. It can be user-supplied.

object (BillingDocumentSettings)

Billing document settings for an account

batch
string

The identifier of a bill run batch.

bill_cycle_day
integer [ 0 .. 31 ]

The day of the month on which your customer will be invoiced. For month-end specify 31.

required
object (AccountContactCreateRequest)

Customer billing address.

object (AccountContactCreateRequest)

Customer address used for calculating tax.

communication_profile_id
string

Identifier of the communication profile associated with this customer.

crm_id
string

CRM account identifier.

default_payment_method_id
string

Identifier of the default payment method on the customer account.

name
required
string

The name of the customer account.

description
string

An arbitrary string attached to the object. Often useful for displaying to users.

parent_account_id
string

Identifier of this customer's parent account, if any.

payment_gateway
string

Payment gateway name.

payment_terms
string

Payment terms configured in Billing Settings > Payment Terms of your Zuora tenant.

sequence_set_id
string

The identifier or the billing document sequence set that is assigned to the customer account.

auto_pay
boolean

Controls whether future payments are automatically billed when they are due.

object (TaxCertificate)

The tax certificate information.

object (TaxIdentifier)

An object that contains the VAT Identification number.

currency
required
string

Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated.

sales_rep
string

The name of the sales representative associated with this account.

object (AccountPaymentMethodRequest)

A new payment method for the account.

Responses
201

Default Response

post/accounts
Request samples
application/json
{
  • "name": "Amy Lawrence Account",
  • "currency": "USD",
  • "bill_to": {
    },
  • "sold_to": {
    },
  • "custom_fields": {
    },
  • "payment_terms": "Due Upon Receipt",
  • "tax_certificate": {
    },
  • "sequence_set_id": "8f64d4d793733fb0be444ff770a932c7",
  • "billing_document_settings": {
    }
}
Response samples
application/json
{
  • "id": "8ad085518262bc17018265525eab3696",
  • "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  • "updated_time": "2022-08-03T13:07:53-07:00",
  • "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  • "created_time": "2022-08-03T13:07:53-07:00",
  • "custom_fields": {
    },
  • "account_number": "RC-00020489",
  • "billing_document_settings": {
    },
  • "batch": "Batch1",
  • "bill_cycle_day": 0,
  • "communication_profile_id": "",
  • "crm_id": "",
  • "default_payment_method_id": "",
  • "name": "Amy Lawrence Account",
  • "description": "",
  • "payment_gateway": "",
  • "payment_terms": "Due Upon Receipt",
  • "auto_pay": false,
  • "currency": "USD",
  • "enabled": true,
  • "remaining_debit_memo_balance": 0,
  • "remaining_invoice_balance": 0,
  • "remaining_credit_memo_balance": 0,
  • "remaining_payment_balance": 0,
  • "bill_to_id": "8ad085518262bc17018265525ebb3697",
  • "sold_to_id": "8ad085518262bc17018265525ec43699"
}