This API Reference contains the API operations that we no longer recommend you use.
Although we do not recommend these API operations, you can continue to use these API operations if you have integrated with them. You are not required to make changes to your existing integration.
For more information about this change, see this Community post.
Actions are operations that are batch in nature. For example, the "create", "update", "delete", and other operations allow changes to up-to 50 objects at a time. The "query" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent "queryMore" operation.
The default WSDL version for Actions is 79. If you want to change the WSDL version, set the X-Zuora-WSDL-Version header. To find out in which WSDL version a particular object or field was introduced, see Zuora SOAP API Version History.
Note: Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature.
Some operations in this section are similar to each other, but are provided for different use scenarios. You should choose the one that best suits your needs.
For example, the Create account operation is used to create an account with a credit card payment method, a bill-to contact, and optionally an sold-to contact or an associated subscription. If you want to create an account without creating any associated objects such as subscriptions, use CRUD: Create Account instead.
If you want to create an account and the associated subscription at the same time without providing credit card information, use the Subscribe action.
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.
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.
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.
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.
The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
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.
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 (').
Unique account number assigned to the account. Character limit: 50 Values: one of the following:
List of additional email addresses to receive email notifications. Character limit: 120 Values: comma-separated list of email addresses
Indicates if associated invoices can be edited. Character limit: 5 Values: true, false (default if left null)
Indicates if future payments are automatically collected when they're due during a Payment Run. Character limit: 5 Values: true, false (default)
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 <a href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite" target="_blank">Performance Booster Elite</a> package.
Billing cycle day setting option. Character limit: 9 Values: AutoSet, ManualSet
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)
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
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
Name of the account's customer service representative, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
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
Indicates if the customer wants to receive invoices through email. Character limit: 5 Values: true, false (default if left null)
Indicates if the customer wants to receive printed invoices, such as through postal mail. Character limit: 5 Values: true, false (default if left null)
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
Name of the account as displayed in the Zuora UI. Character limit: 255 Values: a string of 255 characters or fewer
Comments about the account. Character limit: 65,535 Values: a string of 65,535 characters
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
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:
X-Zuora-WSDL-Version request header to 131 or later.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:
Indicates when the customer pays for subscriptions. Character limit: 100 Values: a valid, active payment term defined in the web-based UI administrative settings
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
The name of the sales representative associated with this account, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
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
Status of the account in the system.
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
ID of your customer's tax exemption certificate. Character limit: 32 Values: a string of 32 characters or fewer
Type of the tax exemption certificate that your customer holds. Character limit: 32 Values: a string of 32 characters or fewer
Description of the tax exemption certificate that your customer holds. Character limit: 500 Values: a string of 500 characters or fewer
Date when the the customer's tax exemption starts. Character limit: 29 Version notes: requires Zuora Tax
Date when the customer's tax exemption certificate expires Character limit: 29 Version notes: requires Zuora Tax
Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Character limit: 32 Values: a string of 32 characters or fewer
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:
YesNoPendingVerificationEU 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
Associates the account with a specified communication profile. Character limit: 32 Values: a valid communication profile ID
Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Value of the Department field for the corresponding customer account in 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.
Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Date when the account was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Account object. The name of each custom field has the form <code>customField__c</code>. Custom field names are case sensitive. See Manage Custom Fields for more information.
curl -i -X POST \
'https://developer.zuora.com/_mock/v1-api-reference/older-api/v1/object/account?rejectUnknownFields=false' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: string' \
-H 'X-Zuora-WSDL-Version: 79' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string' \
-d '{
"Name": "Amy Lawrence",
"Currency": "USD",
"BillCycleDay": 1,
"Status": "Draft"
}'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/jsonapplication/xmltext/htmltext/csvtext/plainThe request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "Success": true, "Id": "2c93808457d787030157e0321fdf4fab" }
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.
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.
The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
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.
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 (').
curl -i -X GET \
'https://developer.zuora.com/_mock/v1-api-reference/older-api/v1/object/account/{id}?fields=string' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'X-Zuora-WSDL-Version: 79' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'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/jsonapplication/xmltext/htmltext/csvtext/plainThe request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
Unique account number assigned to the account. Character limit: 50 Values: one of the following:
List of additional email addresses to receive email notifications. Character limit: 120 Values: comma-separated list of email addresses
Indicates if associated invoices can be edited. Character limit: 5 Values: true, false (default if left null)
Indicates if future payments are automatically collected when they're due during a Payment Run. Character limit: 5 Values: true, false (default)
Current outstanding balance for the account. Character limit: 16 Values: automatically generated
Organizes your customer accounts into groups to optimize your billing and payment operations. Required if you use the Subscribe call Character limit: 20 Values:any system-defined batch (Batch1 - Batch50 or by name).
Billing cycle day setting option. Character limit: 9 Values: AutoSet, ManualSet
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)
ID of the person to bill for the account. Character limit: 32 Values: a valid contact ID for the account
Associates the account with a specified communication profile. Character limit: 32 Values: a valid communication profile ID
ID of the Zuora user who created the Account object. Character limit: 32 Values: automatically generated
Date when the Account object was created. Character limit: 29 Values: automatically generated
Total credit balance for the account. Character limit: 16 Values: automatically generated
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
Name of the account's customer service representative, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
ID of the default payment method for the account. This field is required if the AutoPay field is set to true. Character limit: 32 Values: a valid ID for an existing payment method
Indicates if the customer wants to receive invoices through email. Character limit: 5 Values: true, false (default if left null)
Indicates if the customer wants to receive printed invoices, such as through postal mail. Character limit: 5 Values: true, false (default if left null)
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
The date when the previous invoice was generated for the account. The field value is null if no invoice has ever been generated for the account. Character limit: 29 Values: automatically generated
The date and time when account metrics are last updated, if the account is a partner account.
Note:
PartnerAccount field to false for an account, the value of the lastMetricsUpdate field is automatically set to null in the response.PartnerAccount field to true for an account, the value of lastMetricsUpdate field is the time when the account metrics are last updated.X-Zuora-WSDL-Version request header to 131 or later.Name of the account as displayed in the Zuora UI. Character limit: 255 Values: a string of 255 characters or fewer
Comments about the account. Character limit: 65,535 Values: a string of 65,535 characters
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
Whether the customer account is a partner, distributor, or reseller.
Note:
X-Zuora-WSDL-Version request header to 131 or later.Gateway used for processing electronic payments and refunds. Character limit: 40 Values: one of the following:
Indicates when the customer pays for subscriptions. Character limit: 100 Values: a valid, active payment term defined in the web-based UI administrative settings
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
The name of the sales representative associated with this account, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
ID of the person who bought the subscription associated with the account. Character limit: 32 Values: a valid contact ID for the account
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
ID of your customer's tax exemption certificate. Character limit: 32 Values: a string of 32 characters or fewer
Type of the tax exemption certificate that your customer holds. Character limit: 32 Values: a string of 32 characters or fewer
Description of the tax exemption certificate that your customer holds. Character limit: 500 Values: a string of 500 characters or fewer
Date when the the customer's tax exemption starts. Character limit: 29 Version notes: requires Zuora Tax
Date when the customer's tax exemption certificate expires Character limit: 29 Version notes: requires Zuora Tax
Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Character limit: 32 Values: a string of 32 characters or fewer
Status of the account's tax exemption. Required if you use Zuora Tax. Character limit: 19 Values: one of the following:
YesNoPendingVerificationTotal balance of the account's invoices. Character limit: 16 Values: a valid currency value
ID of the user who last updated the account. Character limit: 32 Values: automatically generated
Date when the account was last updated. Character limit: 29 Values: automatically generated
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
Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Value of the Department field for the corresponding customer account in 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.
Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Date when the account was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Account object. The name of each custom field has the form <code>customField__c</code>. Custom field names are case sensitive. See Manage Custom Fields for more information.
{ "AccountNumber": "AN_1476935136687", "AllowInvoiceEdit": false, "Id": "2c93808457d787030157e031b5b74a9d", "AutoPay": true, "InvoiceDeliveryPrefsPrint": false, "UpdatedDate": "2016-10-20T05:45:37.000+02:00", "CreditBalance": 0, "BillCycleDay": 1, "BcdSettingOption": "ManualSet", "PaymentTerm": "Due Upon Receipt", "Status": "Draft", "TotalInvoiceBalance": 0, "UpdatedById": "2c93808457d787030157e0319d644922", "Batch": "Batch1", "CreatedById": "2c93808457d787030157e0319d644922", "InvoiceDeliveryPrefsEmail": false, "Name": "AC_1476935136687", "SoldToId": "2c93808457d787030157e031b6444a9e", "Notes": "this is notes", "Balance": 0, "InvoiceTemplateId": "2c93808457d787030157e031a33c4a94", "CrmId": "crmid", "BillToId": "2c93808457d787030157e031b6444a9e", "CreatedDate": "2016-10-20T05:45:36.000+02:00", "DefaultPaymentMethodId": "2c93808457d787030157e031b6d24a9f", "Currency": "USD", "PartnerAccount": true, "LastMetricsUpdate": "2023-01-10T03:42:18.000+02:00" }
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.
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.
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.
The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
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.
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 (').
Unique account number assigned to the account. You can modify the account number of a customer account only if the account has no subscriptions or draft subscriptions only. Otherwise, the account number cannot be modified. Character limit: 50 Values: one of the following:
List of additional email addresses to receive email notifications. Character limit: 120 Values: comma-separated list of email addresses
Indicates if associated invoices can be edited. Character limit: 5 Values: true, false (default if left null)
Indicates if future payments are automatically collected when they're due during a Payment Run. Character limit: 5 Values: true, false (default)
Organizes your customer accounts into groups to optimize
\ your billing and payment operations. Required if you use the Subscribe
\ call.\nCharacter 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 <a href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite" target="_blank">Performance Booster Elite</a> package.
Billing cycle day setting option. Character limit: 9 Values: AutoSet, ManualSet
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)
ID of the person to bill for the account. Character limit: 32 Values: a valid contact ID for the account
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
Currency that the customer is billed in.
You can update this field only when an account is in Draft status. After the account is activated, you cannot update this field.
Name of the account's customer service representative, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
ID of the default payment method for the account. This field is required if the AutoPay field is set to true. Character limit: 32 Values: a valid ID for an existing payment method
Indicates if the customer wants to receive invoices through email. Character limit: 5 Values: true, false (default if left null)
Indicates if the customer wants to receive printed invoices, such as through postal mail. Character limit: 5 Values: true, false (default if left null)
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
Name of the account as displayed in the Zuora UI. Character limit: 255 Values: a string of 255 characters or fewer
Comments about the account. Character limit: 65,535 Values: a string of 65,535 characters
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
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:
X-Zuora-WSDL-Version request header to 131 or later.Gateway used for processing electronic payments and refunds. Character limit: 40 Values: one of the following:
Indicates when the customer pays for subscriptions. Character limit: 100 Values: a valid, active payment term defined in the web-based UI administrative settings
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
The name of the sales representative associated with this account, if applicable. Character limit: 50 Values: a string of 50 characters or fewer
ID of the person who bought the subscription associated with the account. Character limit: 32 Values: a valid contact ID for the account
Status of the account in the system.
Follow the following rules to update the status of accounts:
BillToId and SoldToId fields when you change the Status field value to Active.Canceled, cancel all subscriptions associated with this account. You cannot cancel an account that has active subscriptions.Draft.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
ID of your customer's tax exemption certificate. Character limit: 32 Values: a string of 32 characters or fewer
Type of the tax exemption certificate that your customer holds. Character limit: 32 Values: a string of 32 characters or fewer
Description of the tax exemption certificate that your customer holds. Character limit: 500 Values: a string of 500 characters or fewer
Date when the the customer's tax exemption starts. Character limit: 29 Version notes: requires Zuora Tax
Date when the customer's tax exemption certificate expires Character limit: 29 Version notes: requires Zuora Tax
Indicates the jurisdiction in which the customer's tax exemption certificate was issued. Character limit: 32 Values: a string of 32 characters or fewer
Status of the account's tax exemption. Required if you use Zuora Tax. Character limit: 19 Values: one of the following:
YesNoPendingVerificationEU 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
Associates the account with a specified communication profile. Character limit: 32 Values: a valid communication profile ID
Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Value of the Department field for the corresponding customer account in 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.
Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
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.
Date when the account was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
Custom fields of the Account object. The name of each custom field has the form <code>customField__c</code>. Custom field names are case sensitive. See Manage Custom Fields for more information.
curl -i -X PUT \
'https://developer.zuora.com/_mock/v1-api-reference/older-api/v1/object/account/{id}?rejectUnknownFields=false' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Content-Type: application/json' \
-H 'X-Zuora-WSDL-Version: 79' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string' \
-d '{
"BillCycleDay": 1
}'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/jsonapplication/xmltext/htmltext/csvtext/plainThe request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "Success": true, "Id": "2c93808457d787030157e0321fdf4fab" }
Deletes a specific account asynchronously.
Note: When Orders is enabled, before deleting a customer account, you must delete all related orders and subscriptions where this account has been referenced as a subscription owner or invoice owner.
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.
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.
The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
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.
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 (').
curl -i -X DELETE \
'https://developer.zuora.com/_mock/v1-api-reference/older-api/v1/object/account/{id}' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'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/jsonapplication/xmltext/htmltext/csvtext/plainThe request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "success": true, "id": "2c93808457d787030157e031b1ea4a98" }
You can use amendments to modify subscriptions. However, Zuora recommends you to use the Create an order operation to do so.
This section contains the CRUD bill run operations, including:
The Charge Revenue Summary represents a summary of revenue amounts from all revenue schedules on the whole subscription charge. For example, revenue for one-time setup charges, recurring charges, and overages.
You can list all details of a charge revenue summary or retrieve a charge revenue summary by charge ID through the REST API.
A communication profile enables you to send specific event-driven notifications to targeted customer accounts. For more information, see Communication profiles.
You can manage communication profiles using the REST API:
Establishes a connection to the Zuora REST API service based on a valid user credentials.
Note: This is a legacy REST API. Zuora recommends you to use OAuth for authentication instead.
You can create, update, and retrieve custom document properties for a billing document. For example, a document property can be a custom name used for files generated for billing documents. Billing documents include invoices, credit memos, and debit memos.
Note: You can manage document properties for credit memos and debit memos only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement" target="_blank">Invoice Settlement</a> feature enabled.
An entity represents a business unit that operates independently and can sell products to multiple countries. Each entity has its own Zuora environment in which the entity users can perform business operations independent of the other entities. In a multi-entity hierarchy, an entity can share certain business objects with the other entities. Users that are created in an entity can be granted access to the other entities with different roles and permissions.
Note: Entities are available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity" target="_blank">Multi-entity</a> feature enabled. If you want to have access to the Multi-entity feature, submit a request at <a href=“http://support.zuora.com/” target=“_blank”>Zuora Global Support</a>.
If you want to share business objects across entities, you have to set up a connection between the source entity and the target entity first.
Note: Entity connections are available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity" target="_blank">Multi-entity</a> feature enabled. If you want to have access to the Multi-entity feature, submit a request at <a href=“http://support.zuora.com/” target=“_blank”>Zuora Global Support</a>.
You can export items from Zuora to CSV or HTML files, such as large data sets, invoices, payments, and so on. Use the Export object and Export ZOQL queries to create an export file that you can download and use for charting, reporting, accounting, or for other business intelligence uses.
When you export data from Zuora, each exported file is available for download for 7 days. Export objects older than 90 days are automatically deleted.
After you have created a feature, you can add features to the products and subscriptions to enhance your product offerings.
To create features in the product catalog and use them in subscriptions and Zuora Quotes, you need to enable the following:
A Hash-based Message Authentication Code (HMAC) signature is a form of a digital signature. HMAC signatures start with a secret key that is shared between the sender and the recipient.
You can use the operation contained in this section to generate the unique signature and token values that are used to process CORS-enabled API calls.
An invoice adjustment modifies an existing invoice. You use an invoice adjustment to change the entire invoice. For example, you can apply a late fee to the invoice balance.
An invoice adjustment differs from an invoice item adjustment. An invoice item adjustment affects an individual charge or line item on an invoice. An invoice adjustment affects the invoice at the header-level.
Note: Invoice Adjustment is deprecated on Production in WSDL version 64.0. Zuora recommends that you use the Invoice Item Adjustment to adjust invoices. If you have the <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement" target="_blank">Invoice Settlement</a> feature enabled, this object is deprecated and only available for backward compatibility.
Invoice item adjustments allow you to adjust the invoice details, including taxes at the charge level, and have those adjustments reported in the system under the same accounting code as the items that are being adjusted.
Note: The <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement" target="_blank">Invoice Settlement</a> feature is a replacement for Invoice Item Adjustments. We recommend that you enable Invoice Settlement to take advantage of the improved functionalities. If you have the Invoice Settlement feature enabled, the Invoice Item Adjustments feature is deprecated and invoice item adjustments are not presented in the UI. If you have to export data for invoice item adjustments, use <a href="https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/D_Generate_a_Data_Source_Export" target="_blank">Data Source</a>, <a href="https://knowledgecenter.zuora.com/Central_Platform/Query/Data_Query" target="_blank">Data Query</a>, or REST API.
Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts.
For more information about invoices, see <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/A1_Invoice_Introduction" target="_blank">Invoice</a>.
You can use the Retrieve a payment gateway transaction log operation to retrieve log data about all transactions processed through your setup payment gateways.
This section contains the Generate a quote document operation that should be only used from Zuora Quotes.
This operation generates a quote document and returns the generated document URL. You can directly access the generated quote file through the returned URL.
A rate plan charge tier is part of a subscription or an amendment to a subscription, and it comes from a product rate plan charge tier. A rate plan charge tier holds the prices for a rate plan charge. Each rate plan charge has at least one tier associated with it.
Rate plan charge tiers are sometimes called subscription rate plan charge tiers to distinguish them from product rate plan charge tiers. Rate plan charge tiers that are part of an amendment are sometimes called amendment rate plan charge tiers for the same reason. However, the object name is RatePlanChargeTier, not SubscriptionRatePlanChargeTier nor AmendmentRatePlanChargeTier: these latter two names don't exist.
A rate plan charge is part of a subscription or an amendment to a subscription, and it comes from a product rate plan charge. Like a product and its product rate plan charges, a subscription can have one or more rate plan charges. Rate plan charges represent the actual charges for the rate plans or services that you sell.
Rate plan charges are sometimes called subscription rate plan charges to distinguish them from product rate plan charges. Rate plan charges that are part of an amendment are sometimes called amendment rate plan charges for the same reason. The object name is RatePlanCharge – not SubscriptionRatePlanCharge nor AmendmentRatePlanCharge.
A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans. Rate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.
Rate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription.
This section contains the CRUD: Retrieve a refund invoice payment operation. You can use this operation to retrieve information from Refund Invoice Payment and associated invoices, payments, and accounts.
This section contains the CRUD: Retrieve a refund transaction log operation. This operation allows you to export a log of all transactions from Zuora to the gateway for the refund.
Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check). In addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.
The Zuora Reporting API enables you to access reports that you have created in the Zuora UI, manage report runs, and export the results of report runs.
The endpoints of the Reporting API are the same as the endpoints of Zuora REST API. The following table provides some endpoints as reference:
| Environment | API Endpoint |
|---|---|
| API Sandbox (US Cloud Data Center 1) | https://rest.sandbox.na.zuora.com |
| Production (US Cloud Data Center 1) | https://rest.na.zuora.com |
| API Sandbox (US Cloud Data Center 2) | https://rest.apisandbox.zuora.com |
| Production (US Cloud Data Center 2) | https://rest.zuora.com |
| API Sandbox (EU Data Center) | https://rest.sandbox.eu.zuora.com |
| Production (EU Data Center) | https://rest.eu.zuora.com |
| US Central Sandbox | https://rest.test.zuora.com |
| EU Central Sandbox | https://rest.test.eu.zuora.com |
| APAC Developer & Central Sandbox | https://rest.test.ap.zuora.com |
| APAC Production | https://rest.ap.zuora.com |
Historically, the endpoints of the Reporting API were different from the endpoints of the Zuora REST API.
Note that you are still able to use the following endpoints, but it is unrecommended and you can only use username and password to authenticate to the Reporting API. We recommend you to use OAuth to authenticate to the Reporting API. OAuth only works with new endpoints. The endpoints of the Reporting API were:
| Environment | API Endpoint |
|---|---|
| API Sandbox (US Cloud Data Center 1) | https://zconnect.sandbox.na.zuora.com/api/rest/v1 |
| Production (US Cloud Data Center 1) | https://zconnect.na.zuora.com/api/rest/v1 |
| API Sandbox (US Cloud Data Center 2) | https://zconnectsandbox.zuora.com/api/rest/v1 |
| Production (US Cloud Data Center 2) | https://zconnect.zuora.com/api/rest/v1 |
| API Sandbox (EU Data Center) | https://zconnect.sandbox.eu.zuora.com/api/rest/v1 |
| Production (EU Data Center) | https://zconnect.eu.zuora.com/api/rest/v1 |
| US Central Sandbox | https://zconnect-services0001.test.zuora.com/api/rest/v1 |
| EU Central Sandbox | https://zconnect-services0002.test.eu.zuora.com/api/rest/v1 |
| APAC Developer & Central Sandbox | https://zconnect-services0003.test.ap.zuora.com |
| APAC Production | http://zconnect-prod05.ap.zuora.com |
A revenue event is a record or audit trail about a change to a revenue schedule. When you manually distribute revenue schedule, if no change is made to the revenue schedule, no revenue events will not be created.
A revenue event is comprised of:
The Entitlements settings must be enabled to use this operation. Access to the Entitlements feature requires a specific edition of Zuora. See Zuora Editions for details.
A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as activation fees. Every subscription must be associated with an account. At least one active account must exist before any subscriptions can be created.
For more information, see <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Subscriptions" target="_blank">Subscriptions</a>.
The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by <a href="https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax" target="_blank">Z-Tax</a> or a third-party tax engine such as <a href="https://knowledgecenter.zuora.com/Billing/Taxes/Direct_Avalara_Integration" target="_blank">Avalara</a> or <a href="https://knowledgecenter.zuora.com/Billing/Taxes/Additional_resources_on_taxes/AA_Connect_Tax_Engines" target="_blank">Connect tax engine</a>.
Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions.
You can view all transactions associated with an account, including:
A unit of measure (UOM) is the definable unit that you measure when determining charges. For example, if a customer's subscription rate plan includes 20 licenses, then 20 is the quantity and license is the unit that the quantity measures.
You can customize the units of measure (UOM) your company uses to measure the use of your services; for example, minutes, people, seats, and licenses can all be units of measure.
This section contains the legacy API operations for Usage.
For the "Retrieve a usage record" operation, we recommend that you use the following Object Query operations instead: