---
title: "Retrieve an account summary"
method: GET
path: "/v1/accounts/{account-key}/summary"
tags: ["Accounts"]
---

# Retrieve an account summary

`GET /v1/accounts/{account-key}/summary`

Retrieves detailed information about the specified customer account.

The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.

### Notes
Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size.

## Path parameters

- `account-key` string, required

## Query parameters

- `excludeUsage` boolean

## 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

- GETAccountSummaryType
  - `basicInfo` GETAccountSummaryTypeBasicInfo — Container for basic information about the account.
    - `accountNumber` string — Account number.
    - `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.
    - `balance` string, decimal — Current outstanding balance.
    - `batch` string — The alias name given to a batch. A string of 50 characters or less.
    - `billCycleDay` string — 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 as defined in Billing Settings in the Zuora UI.
    - `defaultPaymentMethod` object — Information of the default payment method for the account.
      - `creditCardExpirationMonth` string — Two-digit numeric card expiration month as `mm`.
      - `creditCardExpirationYear` string — Four-digit card expiration year as `yyyy`.
      - `creditCardNumber` string — Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234).
      - `creditCardType` string — The type of the credit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Methods](https://docs.zuora.com?resourceId=payments-supported-payment-methods).
      - `id` string — ID of the default payment method associated with this account.
      - `paymentMethodType` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'BankTransfer' | 'PayPal' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' — Type of the payment method. For non-Credit-Card payment methods, only the `id` and `paymentMethodType` fields are returned.
    - `id` string — Account ID.
    - `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.
    - `lastInvoiceDate` string, date — Date of the most recent invoice for the account; null if no invoice has ever been generated.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-reseller-account" target="_blank">Reseller Account</a> 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.
    - `lastPaymentAmount` string, decimal — Amount of the most recent payment collected for the account; null if no payment has ever been collected.
    - `lastPaymentDate` string, date — Date of the most recent payment collected for the account. Null if no payment has ever been collected.
    - `name` string — Account name.
    - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
    - `partnerAccount` boolean — Whether the customer account is a partner, distributor, or reseller. **Note**: This field is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-reseller-account" target="_blank">Reseller Account</a> feature enabled.
    - `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.
    - `purchaseOrderNumber` string — The purchase order number provided by your customer for services, products, or both purchased.
    - `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` GETAccountSummaryTypeBillToContact — Container for bill-to contact information. **Notes**: - If the bill-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the bill-to contact on the subscription, see <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Overview of Flexible Billing Attributes</a>. - If the bill-to contact is not specified on the subscription, the bill-to contact on the invoice owner account will be populated in this field.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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.
    - `id` string — Contact ID.
    - `isSpecifiedInSubscription` boolean — If `true`, this contact is specified at the subscription level and is not inherited from the customer account.
    - `lastName` string — Last name, 100 characters or less.
    - `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.
  - `invoices` GETAccountSummaryInvoiceType[] — Container for invoices. Only returns the last 6 invoices.
    - `amount` number — Invoice amount before adjustments, discounts, and similar items.
    - `balance` string, decimal — Balance due on the invoice.
    - `dueDate` string, date — Due date as `yyyy-mm-dd`.
    - `id` string — Invoice ID.
    - `invoiceDate` string, date — Invoice date as `yyyy-mm-dd`.
    - `invoiceNumber` string — Invoice number.
    - `status` string — Invoice status - not the payment status of the invoice, just the status of the invoice itself. Possible values are: `Posted`, `Draft`, `Canceled`, `Error`.
  - `payments` GETAccountSummaryPaymentType[] — Container for payments. Only returns the last 6 payments.
    - `effectiveDate` string, date — Effective date as `yyyy-mm-dd`.
    - `id` string — Payment ID.
    - `paidInvoices` GETAccountSummaryPaymentInvoiceType[] — Container for paid invoices for this subscription.
      - `appliedPaymentAmount` string, decimal — Amount of payment applied to the invoice.
      - `invoiceId` string — Invoice ID.
      - `invoiceNumber` string — Invoice number.
    - `paymentNumber` string — Payment number.
    - `paymentType` string — Payment type; possible values are: `External`, `Electronic`.
    - `status` string — Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`.
  - `shipToContact` GetAccountSummaryTypeShipToContact — Container for ship-to contact information. **Notes**: - If the ship-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the ship-to contact on the subscription, see <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Overview of Flexible Billing Attributes</a>. - If the ship-to contact is not specified on the subscription, the ship-to contact on the subscription owner account will be populated in this field.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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.
    - `id` string — Contact ID.
    - `isSpecifiedInSubscription` boolean — If `true`, this contact is specified at the subscription level and is not inherited from the customer account.
    - `lastName` string — Last name, 100 characters or less.
    - `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` GETAccountSummaryTypeSoldToContact — Container for sold-to contact information. **Notes**: - If the sold-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the sold-to contact on the subscription, see <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Overview of Flexible Billing Attributes</a>. - If the sold-to contact is not specified on the subscription, the sold-to contact on the subscription owner account will be populated in this field.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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 <a href="https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself" target="_blank">Feature Management</a>.
    - `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.
    - `id` string — Contact ID.
    - `isSpecifiedInSubscription` boolean — If `true`, this contact is specified at the subscription level and is not inherited from the customer account.
    - `lastName` string — Last name, 100 characters or less.
    - `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.
  - `subscriptions` GETAccountSummarySubscriptionType[] — Container for subscriptions.
    - `autoRenew` boolean — If `true`, auto-renew is enabled. If `false`, auto-renew is disabled.
    - `id` string — Subscription ID.
    - `initialTerm` string — Duration of the initial subscription term in whole months.
    - `ratePlans` GETAccountSummarySubscriptionRatePlanType[] — Container for rate plans for this subscription.
      - `productId` string — Product ID.
      - `productName` string — Product name.
      - `productRatePlanId` string — Product Rate Plan ID.
      - `productSku` string
      - `ratePlanName` string — Rate plan name.
    - `renewalTerm` string — Duration of the renewal term in whole months.
    - `status` string — Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`.
    - `subscriptionNumber` string — Subscription Number.
    - `subscriptionStartDate` string, date — Subscription start date.
    - `termEndDate` string, date — End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate.
    - `termStartDate` string, date — Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date.
    - `termType` string — Possible values are: `TERMED`, `EVERGREEN`.
    - `CpqBundleJsonId__QT` string — The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.
    - `OpportunityCloseDate__QT` string, date — The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
    - `OpportunityName__QT` string — The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
    - `QuoteBusinessType__QT` string — The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
    - `QuoteNumber__QT` string — The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
    - `QuoteType__QT` string — The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
    - `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 subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `Project__NS` string — The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
    - `SalesOrder__NS` string — The NetSuite sales order than the subscription was created from. 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 subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `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.
  - `usage` GETAccountSummaryUsageType[] — Container for usage data. Only returns the last 6 months of usage. **Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field.
    - `quantity` string, decimal — Number of units used.
    - `startDate` string, date — The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date.
    - `unitOfMeasure` string — Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI.

## 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)