- CRUD: Retrieve an account
Retrieves the information about one specific account.
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.
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 (').
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/account/{id}
curl -i -X GET \
'https://rest.zuora.com/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/plain
The 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: 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
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:
- This field is available only if you have the Reseller Account feature enabled.
- If you have the Reseller Account feature enabled, and set the
PartnerAccountfield tofalsefor an account, the value of thelastMetricsUpdatefield is automatically set tonullin the response. - If you ever set the
PartnerAccountfield totruefor an account, the value oflastMetricsUpdatefield is the time when the account metrics are last updated. - This field is only available if you set the
X-Zuora-WSDL-Versionrequest header to131or 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:
- 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-Versionrequest header to131or later.
Gateway used for processing electronic payments and refunds. Character limit: 40 Values: one of the following:
- a valid configured gateway name
- Null to inherit the default value set in Payment Settings
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 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:
YesNoPendingVerification
Total 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 synchronized 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 customField__c. 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" }