POST /v1/accounts

Default value: "application/json"

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.

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

The minor version of the Zuora REST API.

You only need to set this parameter if you use the following fields:

• invoice
• collect
• runBilling
• targetDate

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

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.

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.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

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.

Payment method information associated with an account.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

The unique ID of the credit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.

Whether the sold-to contact and bill-to contact are the same entity.

The created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:

• This field is set to true.
• A bill-to contact is specified.
• No sold-to contact is specified.

The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set.

Required if no subscription will be created.

Optional if a subscription is created and defaults to the day-of-the-month of the subscription's contractEffectiveDate.

Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.

If the value is true, the automatic payment is collected. If the value is false, no action is taken.

Prerequisite: The invoice or runBilling field must be true.

Note: This field is only available if you set the zuora-version request header to 196.0 or later available versions.

Default value: true

The ID of the billing document sequence set to assign to the customer account.

The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.

If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.

Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule.

The billing documents generated in this operation is only for this subscription, not for the entire customer account.

Possible values:

• true: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.

• false: No invoice is created.

Note: This field is in Zuora REST API version control. Supported minor versions are 211.0 and later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

Possible values:

• true
• false

Default value: true

A currency as defined in Billing Settings in the Zuora UI.

For payment method authorization, if the paymentMethod > currencyCode field is specified, currencyCode is used. Otherwise, this currency field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.

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

Possible values:

• "Yes"
• "No"

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

Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.

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

The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

Whether the customer wants to receive printed invoices, such as through postal mail.

Default value: false

Whether future payments are to be automatically billed when they are due.

• If this field is set to true, you must specify either the creditCard field or the hpmCreditCardPaymentMethodId field, but not both.
• If this field is set to false, you can specify neither the creditCard field nor the hpmCreditCardPaymentMethodId field.

A list of additional email addresses to receive email notifications. Use commas to separate email addresses.

Name of the organization that the account belongs to.

This field is only required when you have already turned on Multi-Org feature.

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

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

Whether the customer wants to receive invoices through email.

Default value: false

CRM account ID for the account, up to 100 characters.

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

Payment terms for this account. Possible values are: Due Upon Receipt, Net 30, Net 60, Net 90.

Note: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use Due Upon Receipt as the value instead of the default value set in Billing Settings > Payment Terms from Zuora UI.

Whether to automatically apply credit memos or unapplied payments, or both to an invoice.

If the value is true, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is false, no action is taken.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Invoice template ID, configured in Billing Settings in the Zuora UI.

The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.

If the autoPay field is set to true, you must provide the credit card payment method ID for either this field or the creditCard field, but not both.

For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the paymentMethod field to create a CC Reference Transaction payment method for an account.

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.

Possible values:

• "Company"
• "Individual"

Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.

Note: The credit memo is only available only if you have the Invoice Settlement feature enabled.

This field is in Zuora REST API version control. Supported minor versions are 211.0 and later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

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.

Default value: false

A unique account number, up to 50 characters that do not begin with the default account number prefix. If no account number is specified, one is generated.

The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.

Applies a credit balance to an invoice.

If the value is true, the credit balance is applied to the invoice. If the value is false, no action is taken.

Prerequisite: invoice must be true.

To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.

Note:

• If you are using the field invoiceCollect rather than the field invoice, the invoiceCollect value must be true.
• This field is deprecated if you have the Invoice Settlement feature enabled.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

The unique ID of the debit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.

Account name, up to 255 characters.

The ID of the communication profile that this account is linked to.

You can provide either or both of the communicationProfileId and profileNumber fields.

If both are provided, the request will fail if they do not refer to the same communication profile.

Note: This field has been replaced by the runBilling field. The invoice field is only available for backward compatibility.

Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.

If the value is true, an invoice is created. If the value is false, no action is taken.

Note: This field is only available if you set the zuora-version request header to 196.0 or 207.0.

Default value: true

A string of up to 65,535 characters.

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

• If this field is specified, the specified date is used as the billing document date.
• If this field is not specified, the date specified in the targetDate is used as the billing document date.

Container for tax exempt information, used to establish the tax exempt status of a customer account.

Type of tax exemption certificate that the customer holds. Requires Zuora Tax.

EU Value Added Tax ID.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

ID of the customer tax exemption certificate. Requires Zuora Tax.

Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Jurisdiction in which the customer tax exemption certificate was issued.

Status of the account tax exemption. Requires Zuora Tax.

Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used.

Values: Yes, No(default), pendingVerification. Note that the value will be set to No if no input.

Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.

Date when the customer tax exemption starts. Requires Zuora Tax.

Format: yyyy-mm-dd. Defaults to the current date.

A unique entity use code to apply exemptions in Avalara AvaTax.

This account-level field is required only when you choose Avalara as your tax engine. See Exempt Transactionsfor more details.

Date when the customer tax exemption expires. Requires Zuora Tax.

Format: yyyy-mm-dd. Defaults to the current date.

The number of the communication profile that this account is linked to.

You can provide either or both of the communicationProfileId and profileNumber fields.

If both are provided, the request will fail if they do not refer to the same communication profile.

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

The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment.

Note:

• This field is valid only if the applyCredit field is set to true.
• If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
• If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is ["CreditMemo"], only credit memos are used to apply to invoices.

Note: This field has been replaced by the targetDate field. The invoiceTargetDate field is only available for backward compatibility.

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

This field is in REST API minor version control. To use this field in the method, you can set the zuora-version parameter to the minor version number in the request header. Supported minor versions are 207.0 and earlier available versions.

The alias name given to a batch. A string of 50 characters or less.

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

Note: This field has been replaced by the invoice field and the collect field. invoiceCollect is available only for backward compatibility.

If this field is set to true, and a subscription is created, an invoice is generated at account creation time and payment is immediately collected using the account's default payment method.

Note: This field is only available if you set the zuora-version request header to 186.0, 187.0, 188.0, or 189.0. The default field value is true.

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.