--- title: "Retrieve an account" method: GET path: "/v1/accounts/{account-key}" tags: ["Accounts"] --- # Retrieve an account `GET /v1/accounts/{account-key}` Retrieves basic information about a customer account. This operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account. ## Path parameters - `account-key` string, required ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - GETAccountType - `basicInfo` GETAccountTypeBasicInfo — Container for basic information about the account. **Notes**: - In the "Retrieve an order" operation, if the `getAccountDetails` query parameter is set to `true`, the subscription owner account details `subscriptionOwnerAccountDetails` and invoice owner account details `existingAccountDetails` will be in the response. - In the "Retrieve a subscription by key" operation, the returned result differs based on the following query parameters: - If the `getSubscriptionOwnerDetails` query parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response. - If the `getInvoiceOwnerDetails` query parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response. - If both query parameters are set to `true`, the subscription owner account details `accountOwnerDetails` and invoice owner account details `invoiceOwnerAccountDetails` will be in the response. - `accountNumber` string — Account number. - `batch` string — The alias name given to a batch. A string of 50 characters or less. - `communicationProfileId` string — The ID of the communication profile that this account is linked to. - `creditMemoTemplateId` string — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-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. - `crmId` string — CRM account ID for the account, up to 100 characters. - `customerServiceRepName` string — Name of the account's customer service representative, if applicable. - `debitMemoTemplateId` string — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-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. - `id` string — Account ID. - `invoiceTemplateId` string, nullable — Invoice template ID, configured in Billing Settings in the Zuora UI. - `lastMetricsUpdate` string — 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 `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated. - `name` string — Account name. - `notes` string — Notes associated with the account, up to 65,535 characters. - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. - `parentId` string — Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled. - `partnerAccount` boolean — Whether the customer account is a partner, distributor, or reseller. **Note**: This field is available only if you have the Reseller Account feature enabled. - `profileNumber` string — The number of the communication profile that this account is linked to. - `purchaseOrderNumber` string — The purchase order number provided by your customer for services, products, or both purchased. - `salesRep` string — The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. - `sequenceSetId` string, nullable — The ID of the billing document sequence set that is assigned to the customer account. - `summaryStatementTemplateId` string, nullable — The summary statement template ID. When a user attempts to generate a summary statement from the "Account Summary Statement" screen, the system utilizes this template to produce the PDF. - `status` string — Account status; possible values are: `Active`, `Draft`, `Canceled`. - `tags` string - `Class__NS` string — Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `CustomerType__NS` 'Company' | 'Individual' — 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](https://www.zuora.com/connect/app/?appId=265). - `Department__NS` string — Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `IntegrationId__NS` string — ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `IntegrationStatus__NS` string — Status of the account's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `Location__NS` string — Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `Subsidiary__NS` string — 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](https://www.zuora.com/connect/app/?appId=265). - `SyncDate__NS` string — Date when the account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `SynctoNetSuite__NS` 'Yes' | 'No' — Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). - `billToContact` GETAccountTypeBillToContact — Container for bill-to contact information. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `asBillTo` boolean — Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asShipTo` boolean — Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asSoldTo` boolean — Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `city` string — City - `country` string, nullable — Full country name. This field does not contain the ISO-standard abbreviation of the country name. - `county` string, nullable — Zuora Tax uses this information to calculate county taxation. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `id` string — ID of the person to bill for the account, 32 characters or less. - `lastName` string — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact. - `otherPhone` string, nullable — Other phone number, 40 characters or less. - `otherPhoneType` string, nullable — Possible values are: `Work`, `Mobile`, `Home`, `Other`. - `personalEmail` string — Personal email address. - `state` string — Full state name. This field does not contain the ISO-standard abbreviation of the state name. - `taxRegion` string, nullable — A region string, defined in your Zuora tax rules. - `workEmail` string — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `zipCode` string — Zip code, 20 characters or less. - `billingAndPayment` object — Container for billing and payment information for the account. - `additionalEmailAddresses` string[] — A list of additional email addresses to receive email notifications. - `autoPay` boolean — Whether future payments are automatically collected when they are due during a payment run. - `billCycleDay` integer — Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. - `bcdSettingOption` 'ManualSet' | 'AutoSet' — Bill cycle day setting option. Indicates whether the account’s bill cycle day is managed manually or automatically. - `ManualSet`: The bill cycle day is explicitly set to a specific day of the month (1–31). - `AutoSet`: The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account. This field is system-derived and read-only. Its value is automatically determined based on the `billCycleDay` field. - `currency` string — A currency defined in the web-based UI administrative settings. - `defaultPaymentMethodId` string — ID of the default payment method for the account. - `invoiceDeliveryPrefsEmail` boolean — Whether the customer wants to receive invoices through email. - `invoiceDeliveryPrefsPrint` boolean — Whether the customer wants to receive printed invoices, such as through postal mail. - `paymentMethodCascadingConsent` boolean — `true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. - `paymentGateway` string — The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. - `paymentTerm` string — A payment-terms indicator defined in the web-based UI administrative settings, e.g., "Net 30". - `einvoiceProfile` GetAccountEInvoiceProfile — Container for custom fields of an EinvoiceProfile object. - `businessCategory` 'B2B' | 'B2C' | 'B2G' — The high-level category of the business. - `businessName` string — The full official name that the Buyer is registered with the relevant legal authority. - `businessNumber` string — The unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India. - `businessNumberSchemeId` string — The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person. - `enabled` boolean — Whether the e-invoicing profile for the customer account is enabled. If the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format: - The account must be configured to generate e-invoice files for billing documents. - The billing document must be in Posted status. - A business region must be created for the billing country contact, and be linked to an e-invoicing service provider. - `endpointId` string — The Buyer's electronic address, to which the application-level response to the billing document might be delivered. - `endpointSchemeId` string — The identification scheme identifier of the Buyer’s electronic address. - `taxRegisterNumber` string — The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status. - `gatewayRoutingEligible` boolean — Returns `true` if the applicable billing accounts were was processed successfully for gateway routing . - `metrics` object — Container for account metrics of the account's default currency. If you have the Multiple Currencies feature enabled, the `metricsData` field provides account metrics of different currencies. - `balance` string, decimal — The customer's total invoice balance minus credit balance. - `contractedMrr` string, decimal — Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations. - `creditBalance` string, decimal — Current credit balance. - `reservedPaymentAmount` number, float — The Reserved Payment Amount of the customer account. See [Prepaid Cash with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) for more information. - `totalDebitMemoBalance` string, decimal — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Total balance of all posted debit memos. - `totalInvoiceBalance` string, decimal — Total balance of all posted invoices. - `unappliedCreditMemoAmount` string, decimal — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Total unapplied amount of all posted credit memos. - `unappliedPaymentAmount` string, decimal — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. Total unapplied amount of all posted payments. - `metricsData` GETAccountCurrencyMetricsType[] — Container for account metrics of different currencies. **Note**: This field is available only if you have the Multiple Currencies feature enabled. - `balance` string — The total balance in this currency. - `contractedMrr` string, decimal — The future expected Monthly Recurring Revenue (MRR) in this currency, accounting for future upgrades, downgrades, upsells, and cancellations. - `currency` string — The currency that metrics are aggregated based on. - `reservedPaymentAmount` string, decimal — The reserved payment amount of the customer account in this currency. For more information, see Prepaid Cash with Drawdown. - `totalDebitMemoBalance` string, decimal — The total balance of all posted debit memos in this currency. **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. - `totalInvoiceBalance` string, decimal — The total balance of all posted invoices in this currency. - `unappliedCreditMemoAmount` string, decimal — The total unapplied amount of all posted credit memos in this currency. - `unappliedPaymentAmount` string, decimal — The total unapplied amount of all posted payments in this currency. **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. - `shipToContact` GetAccountTypeShipToContact — Container for ship-to contact information. Uses the same field structure as billToContact. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `asBillTo` boolean — Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asShipTo` boolean — Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asSoldTo` boolean — Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `city` string — City, 40 characters or less. - `country` string, nullable — Full country name. This field does not contain the ISO-standard abbreviation of the country name. - `county` string — County; 32 characters or less. Zuora tax uses this information to calculate county taxation. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `id` string — ID of the person who bought the subscription associated with the account, 32 characters or less. - `lastName` string — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact. - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` string — Possible values are: `Work`, `Mobile`, `Home`, `Other`. - `personalEmail` string — Personal email address. - `state` string — Full state name. This field does not contain the ISO-standard abbreviation of the state name. - `taxRegion` string — A region string, defined in your Zuora tax rules. - `workEmail` string — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `zipCode` string — Zip code, 20 characters or less. - `soldToContact` GETAccountTypeSoldToContact — Container for sold-to contact information. Uses the same field structure as billToContact. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `asBillTo` boolean — Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asShipTo` boolean — Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `asSoldTo` boolean — Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. - `city` string — City, 40 characters or less. - `country` string, nullable — Full country name. This field does not contain the ISO-standard abbreviation of the country name. - `county` string, nullable — County; 32 characters or less. Zuora tax uses this information to calculate county taxation. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `id` string — ID of the person who bought the subscription associated with the account, 32 characters or less. - `lastName` string — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact. - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` string, nullable — Possible values are: `Work`, `Mobile`, `Home`, `Other`. - `personalEmail` string — Personal email address. - `state` string — Full state name. This field does not contain the ISO-standard abbreviation of the state name. - `taxRegion` string, nullable — A region string, defined in your Zuora tax rules. - `workEmail` string — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `zipCode` string — Zip code, 20 characters or less. - `success` boolean — Returns `true` if the request was processed successfully. - `taxInfo` object — Container for tax exempt information, used to establish the tax exempt status of a customer account. - `VATId` string — EU Value Added Tax ID. - `companyCode` string — Unique code that identifies a company account in Avalara. - `exemptCertificateId` string — ID of the customer tax exemption certificate. - `exemptCertificateType` string — Type of tax exemption certificate that the customer holds. - `exemptDescription` string — Description of the tax exemption certificate that the customer holds. - `exemptEffectiveDate` string, date — Date when the customer tax exemption starts. - `exemptEntityUseCode` string — 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 Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. - `exemptExpirationDate` string, date — Date when the customer tax exemption expires. - `exemptIssuingJurisdiction` string — Jurisdiction in which the customer tax exemption certificate was issued. - `exemptStatus` string — Status of the account tax exemption. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)