younifyd
Menu

GET Account

Retrieve an account

GET/v1/accounts/{account-key}

Use it in a workflow

  1. Add a step and choose the Zuora connector.
  2. Pick the GET Account action (under Zuora).
  3. Fill in the fields below, then reference the result from later steps as {{getAccount.response.data}}.

Request

Path parameters

account-keystringrequired

Account number or account ID.

Headers

Accept-Encodingstring

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.

Content-Encodingstring

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.

Zuora-Track-Idstring

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

Zuora-Entity-Idsstring

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).

Response

Returns 200 with an object. Read it in later steps with {{getAccount.response.data.<field>}}.

basicInfoany

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.

billToContactany

Container for bill-to contact information.

billingAndPaymentobject

Container for billing and payment information for the account.

additionalEmailAddressesarray<string>

A list of additional email addresses to receive email notifications.

autoPayboolean

Whether future payments are automatically collected when they are due during a payment run.

billCycleDayinteger (int64)

Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.

bcdSettingOptionstring

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.

One ofManualSetAutoSet

currencystring

A currency defined in the web-based UI administrative settings.

defaultPaymentMethodIdstring

ID of the default payment method for the account.

invoiceDeliveryPrefsEmailboolean

Whether the customer wants to receive invoices through email.

invoiceDeliveryPrefsPrintboolean

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

paymentMethodCascadingConsentboolean

`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.

paymentGatewaystring

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

paymentTermstring

A payment-terms indicator defined in the web-based UI administrative settings, e.g., "Net 30".

einvoiceProfileany

Container for e-invoicing profile information for this account. **Note**: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

gatewayRoutingEligibleboolean

Returns `true` if the applicable billing accounts were was processed successfully for gateway routing .

metricsobject

Container for account metrics of the account's default currency. If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies" target="_blank">Multiple Currencies</a> feature enabled, the `metricsData` field provides account metrics of different currencies.

balancestring (decimal)

The customer's total invoice balance minus credit balance.

contractedMrrstring (decimal)

Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations.

creditBalancestring (decimal)

Current credit balance.

reservedPaymentAmountnumber (float)

The Reserved Payment Amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

totalDebitMemoBalancestring (decimal)

**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total balance of all posted debit memos.

totalInvoiceBalancestring (decimal)

Total balance of all posted invoices.

unappliedCreditMemoAmountstring (decimal)

**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total unapplied amount of all posted credit memos.

unappliedPaymentAmountstring (decimal)

**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total unapplied amount of all posted payments.

metricsDataarray<any>

Container for account metrics of different currencies. **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies" target="_blank">Multiple Currencies</a> feature enabled.

shipToContactany

Container for ship-to contact information. Uses the same field structure as billToContact.

soldToContactany

Container for sold-to contact information. Uses the same field structure as billToContact.

successboolean

Returns `true` if the request was processed successfully.

taxInfoobject

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

VATIdstring

EU Value Added Tax ID.

companyCodestring

Unique code that identifies a company account in Avalara.

exemptCertificateIdstring

ID of the customer tax exemption certificate.

exemptCertificateTypestring

Type of tax exemption certificate that the customer holds.

exemptDescriptionstring

Description of the tax exemption certificate that the customer holds.

exemptEffectiveDatestring (date)

Date when the customer tax exemption starts.

exemptEntityUseCodestring

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.

exemptExpirationDatestring (date)

Date when the customer tax exemption expires.

exemptIssuingJurisdictionstring

Jurisdiction in which the customer tax exemption certificate was issued.

exemptStatusstring

Status of the account tax exemption.

json
{
  "basicInfo": null,
  "billToContact": null,
  "billingAndPayment": {
    "additionalEmailAddresses": [
      "string"
    ],
    "autoPay": false,
    "billCycleDay": 0,
    "bcdSettingOption": "ManualSet",
    "currency": "string",
    "defaultPaymentMethodId": "string",
    "invoiceDeliveryPrefsEmail": false,
    "invoiceDeliveryPrefsPrint": false,
    "paymentMethodCascadingConsent": false,
    "paymentGateway": "string",
    "paymentTerm": "string"
  },
  "einvoiceProfile": null,
  "gatewayRoutingEligible": false,
  "metrics": {
    "balance": "string",
    "contractedMrr": "string",
    "creditBalance": "string",
    "reservedPaymentAmount": 0,
    "totalDebitMemoBalance": "string",
    "totalInvoiceBalance": "string",
    "unappliedCreditMemoAmount": "string",
    "unappliedPaymentAmount": "string"
  },
  "metricsData": [
    null
  ],
  "shipToContact": null,
  "soldToContact": null,
  "success": false,
  "taxInfo": {
    "VATId": "string",
    "companyCode": "string",
    "exemptCertificateId": "string",
    "exemptCertificateType": "string",
    "exemptDescription": "string",
    "exemptEffectiveDate": "2025-01-01",
    "exemptEntityUseCode": "string",
    "exemptExpirationDate": "2025-01-01",
    "exemptIssuingJurisdiction": "string",
    "exemptStatus": "string"
  }
}

Need more? See the Zuora guide for connection setup and behaviour shared by every action.