Skip to content

CRUD: Create an account

Request

Creates an account without creating any associated objects such as subscriptions.

Query
rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Default:false
Headers
Idempotency-Keystring, <= 255 characters

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.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Idsstring

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

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora 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 ("), and quote (').

X-Zuora-WSDL-Versionstring

Zuora WSDL version number.

Default:79
Bodyapplication/jsonrequired
AccountNumberstring

Unique account number assigned to the account. Character limit: 70 Values: one of the following:

  • null to auto-generate
  • a string of 70 characters or fewer that doesn't begin with the default account number prefix
AdditionalEmailAddressesstring

List of additional email addresses to receive email notifications. Character limit: 120 Values: comma-separated list of email addresses

AllowInvoiceEditboolean

Indicates if associated invoices can be edited. Character limit: 5 Values: true, false (default if left null)

AutoPayboolean

Indicates if future payments are automatically collected when they're due during a Payment Run. Character limit: 5 Values: true, false (default)

Batchstring

Organizes your customer accounts into groups to optimize
\ your billing and payment operations. Required if use the Subscribe call.\n
Character limit: 20 Values:any system-defined batch (Batch1
\ - Batch50 or by name).

Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.

BcdSettingOptionstring

Billing cycle day setting option. Character limit: 9 Values: AutoSet, ManualSet

BillCycleDayinteger, (int32)required

Billing cycle day (BCD) on which bill runs generate invoices for the account. Character limit: 2 Values: any activated system-defined bill cycle day (1 - 31)

Example:1
BillToIdstring

ID of the person to bill for the account. This field is only required if the Status field is set to Active. Character limit: 32 Values: a valid contact ID for the account

CrmIdstring

CRM account ID for the account. A CRM is a customer relationship management system, such as Salesforce.com. Character limit: 100 Values: a string of 100 characters or fewer

Currencystringrequired

Currency that the customer is billed in.

Example:"USD"
CustomerServiceRepNamestring

Name of the account's customer service representative, if applicable. Character limit: 50 Values: a string of 50 characters or fewer

DefaultPaymentMethodIdstring

ID of the default payment method for the account. This field is only required if the AutoPay field is set to true. For a specified credit card payment method, it is recommended that the support for stored credential transactions for this payment method is already enabled. Character limit: 32 Values: a valid ID for an existing payment method

InvoiceDeliveryPrefsEmailboolean

Indicates if the customer wants to receive invoices through email. Character limit: 5 Values: true, false (default if left null)

InvoiceDeliveryPrefsPrintboolean

Indicates if the customer wants to receive printed invoices, such as through postal mail. Character limit: 5 Values: true, false (default if left null)

InvoiceTemplateIdstring

The ID of the invoice template. Each customer account can use a specific invoice template for invoice generation. Character limit: 32 Values: a valid template ID configured in Zuora Billing Settings

Namestringrequired

Name of the account as displayed in the Zuora UI. Character limit: 255 Values: a string of 255 characters or fewer

Example:"Amy Lawrence"
Notesstring

Comments about the account. Character limit: 65,535 Values: a string of 65,535 characters

ParentIdstring

Identifier of the parent customer account for this Account object. Use this field if you have customer hierarchy enabled. Character limit: 32 Values: a valid account ID

PartnerAccountboolean

Whether the customer account is a partner, distributor, or reseller.

You can set this field to true if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to true, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.

Note:

  • This field is available only if you have the Reseller Account feature enabled.
  • This field is only available if you set the X-Zuora-WSDL-Version request header to 131 or later.
Default:false
PaymentGatewaystring

Gateway used for processing electronic payments and refunds. This field is only required if there is no default payment gateway is defined in the tenant. Character limit: 40 Values: one of the following:

  • a valid configured gateway name
  • Null to inherit the default value set in Zuora Payment Settings
PaymentTermstring

Indicates when the customer pays for subscriptions. Character limit: 100 Values: a valid, active payment term defined in the web-based UI administrative settings

PurchaseOrderNumberstring

The number of the purchase order associated with this account. Purchase order information generally comes from customers. Character limit: 100 Values: a string of 100 characters or fewer

SalesRepNamestring

The name of the sales representative associated with this account, if applicable. Character limit: 50 Values: a string of 50 characters or fewer

SoldToIdstring

ID of the person who bought the subscription associated with the account. This field is only required if the Status field is set to Active. Character limit: 32 Values: a valid contact ID for the account

Statusstring, <= 8 charactersrequired

Status of the account in the system.

Enum:"Draft""Active""Canceled"
Example:"Draft"
TaxCompanyCodestring

Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Character limit: 50 Values: a valid company code

TaxExemptCertificateIDstring

ID of your customer's tax exemption certificate. Character limit: 32 Values: a string of 32 characters or fewer

TaxExemptCertificateTypestring

Type of the tax exemption certificate that your customer holds. Character limit: 32 Values: a string of 32 characters or fewer

TaxExemptDescriptionstring

Description of the tax exemption certificate that your customer holds. Character limit: 500 Values: a string of 500 characters or fewer

TaxExemptEffectiveDatestring, (date)

Date when the customer's tax exemption starts. Character limit: 29 Version notes: requires Zuora Tax

TaxExemptExpirationDatestring, (date)

Date when the customer's tax exemption certificate expires Character limit: 29 Version notes: requires Zuora Tax

TaxExemptIssuingJurisdictionstring

Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Character limit: 32 Values: a string of 32 characters or fewer

TaxExemptStatusstring

Status of the account's tax exemption. This field is only required if you use Zuora Tax. This field is not available if you do not use Zuora Tax. Character limit: 19 Values: one of the following:

  • Yes
  • No
  • PendingVerification
VATIdstring

EU Value Added Tax ID. This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Character limit: 25 Values: a valid Value Added Tax ID

communicationProfileIdstring

Associates the account with a specified communication profile. Character limit: 32 Values: a valid communication profile ID

Class__NSstring, <= 255 characters

Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

CustomerType__NSstring

Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Enum:"Company""Individual"
Department__NSstring, <= 255 characters

Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationId__NSstring, <= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring, <= 255 characters

Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Location__NSstring, <= 255 characters

Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Subsidiary__NSstring, <= 255 characters

Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring, <= 255 characters

Date when the account was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SynctoNetSuite__NSstring

Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Enum:"Yes""No"
<property name>anyadditional property

Custom fields of the Account object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

{ "Name": "Amy Lawrence", "Currency": "USD", "BillCycleDay": 1, "Status": "Draft" }

Responses

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
Idstring
Example:"2c93808457d787030157e030232f3748"
Successboolean
Example:true
Response
{ "Success": true, "Id": "2c93808457d787030157e0321fdf4fab" }