--- title: "Retrieve a prepaid balance" method: GET path: "/object-query/prepaid-balances/{key}" tags: ["Object Queries"] --- # Retrieve a prepaid balance `GET /object-query/prepaid-balances/{key}` Retrieve the details of a specific Prepaid Balance object. ## Path parameters - `key` string, required ## Query parameters - `pageSize` integer - `cursor` string - `sort[]` string[] - `expand[]` string[] - `filter[]` string[] - `fields[]` string[] - `includeNullFields` boolean ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - ExpandedPrepaidBalance - `id` string — The unique identifier of the prepaid balance. - `createdById` string — The unique identifier of the user who created the payment application. - `createdDate` string, date-time — The date and time when the payment application was created. - `updatedById` string — The unique identifier of the user who last updated the payment application. - `updatedDate` string, date-time — The date and time when the payment application was last updated. - `name` string — The name of the prepaid balance. - `totalFund` number — The total amount of all prepaid balance funds. - `balance` number — The current prepaid balance. - `endDate` string, date — End date of the validity period. - `startDate` string, date — Start date of the validity period. - `accountId` string — The ID of the customer account to which the prepaid balance belongs. - `origSubscriptionId` string — If it belongs to a subscription, the original subscription ID. - `uOM` string — The units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Values**: a valid unit of measure - `prepaidBalanceState` 'ACTIVE' | 'EXPIRED' — The state of the prepaid balance. - `prepaidType` integer, nullable — The type of the prepaid balance. - `account` NestedAccountOnExpand - `id` string — The unique identifier of the account. - `createdById` string — The unique identifier of the user who created the account. - `createdDate` string, date-time — The date and time when the account was created. - `updatedById` string — The unique identifier of the user who last updated the account. - `updatedDate` string, date-time — The date and time when the account was last updated. - `accountNumber` string — The account number that identifies the account. - `additionalEmailAddresses` string — An additional email address to receive email notifications. - `allowInvoiceEdit` boolean — Indicates whether associated invoices can be edited. - `autoPay` boolean — Indicates whether future payments are automatically collected when they are due during a payment run. - `balance` number, double — The customer's total invoice balance minus credit balance. - `batch` string — The alias name given to a batch. A string of 50 characters or less. - `bcdSettingOption` 'ManualSet' | 'AutoSet' — The billing cycle day setting option for the account. - `billCycleDay` integer — Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. - `billToId` string — The unique identifier of the bill-to contact associated with the account. - `communicationProfileId` string — The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts. - `creditBalance` number, double — The current credit balance on the account. - `crmId` string — External identifier of the account in a CRM system. - `currency` string — A currency defined in the web-based UI administrative settings. - `customerServiceRepName` string — Name of the account's customer service representative, if applicable. - `defaultPaymentMethodId` string — ID of the default payment method for the account. - `eInvoiceProfileId` string — ID of the e-invoice profile for this account. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. - `invoiceDeliveryPrefsEmail` boolean — Indicates whether the customer wants to receive invoices through email. - `invoiceDeliveryPrefsPrint` boolean — Whether the customer wants to receive printed invoices, such as through postal mail. - `invoiceTemplateId` string — Invoice template ID, configured in Billing Settings in the Zuora UI. - `lastInvoiceDate` string, date — Date of the most recent invoice for the account; null if no invoice has ever been generated. - `lastMetricsUpdate` string, date-time — 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 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 — The name of the account. - `notes` string — A string of up to 65,535 characters. - `organizationId` string — The unique identifier of the organization to which the account belongs. - `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. - `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. - `salesRepName` string — Name of the account's sales representative, if applicable. - `sequenceSetId` string, nullable — The ID of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set. - `shipToId` string — The unique identifier of the ship-to contact associated with the account. - `soldToId` string — The unique identifier of the sold-to contact associated with the account. - `status` 'Active' | 'Draft' | 'Canceled' — The account status. - `taxCompanyCode` string — Unique code that identifies a company account in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `taxExemptCertificateID` string — ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptCertificateType` string — Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptDescription` string — Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptEffectiveDate` string, date — Date when the customer tax exemption starts, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptEntityUseCode` string — A unique entity use code to apply exemptions in Avalara AvaTax. See Exempt Transactions for more details. - `taxExemptExpirationDate` string, date — Date when the customer tax exemption expires, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines. - `taxExemptIssuingJurisdiction` string — Jurisdiction in which the customer tax exemption certificate was issued. - `taxExemptStatus` 'No' | 'Yes' | 'PendingVerification' — Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. - `totalInvoiceBalance` number, double — Total balance of all posted invoices. - `unappliedBalance` number — Total unapplied balance in this currency. - `vATId` string — EU Value Added Tax ID. - `mrr` number — Monthly recurring revenue for the account. - `totalDebitMemoBalance` number, double — Total balance of all posted debit memos. - `unappliedCreditMemoAmount` number, double — The total unapplied amount of all posted credit memos in this currency. - `creditMemoTemplateId` string — ID of the credit memo template that is used to generate credit memos for the account. - `debitMemoTemplateId` string — ID of the debit memo template that is used to generate debit memos for the account. - `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, for example, `Net 30`. - `billTo` object — The bill-to contact on this account. - `shipTo` object — The ship-to contact on the account. - `soldTo` object — The sold-to contact on the account. - `defaultPaymentMethod` object — The default payment method associated with the account. - `subscriptions` object[] — The subscriptions associated with the account. - `payments` object[] — The payments associated with the account. - `refunds` object[] — The refunds associated with the account. - `creditMemos` object[] — The credit memos associated with the account. - `debitMemos` object[] — The debit memos associated with the account. - `invoices` object[] — The invoices associated with the account. - `usages` object[] — The usage records associated with the account. - `paymentMethods` object[] — The payment methods associated with the account. - `origSubscription` NestedSubscriptionOnExpand - `id` string — The unique identifier of the subscription. - `createdById` string — The unique identifier of the user who created the subscription. - `createdDate` string, date-time — The date and time when the subscription was created in the Zuora system, in the `yyyy-mm-dd hh:mm:ss` format. - `updatedById` string — The unique identifier of the user who last updated the subscription. - `updatedDate` string, date-time — The date and time when the subscription was last updated, in the `yyyy-mm-dd hh:mm:ss` format. - `accountId` string — The ID of the account associated with this subscription. - `autoRenew` boolean — If `true`, the subscription automatically renews at the end of the term. - `cancelledDate` string, date — The date on which the subscription was canceled. - `contractAcceptanceDate` string, date — The date when the customer accepts the contract, in the `yyyy-mm-dd` format. If this field is not set: - If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. - If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate - `contractEffectiveDate` string, date — The date when the subscription is activated, in the `yyyy-mm-dd` format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate - `creatorAccountId` string — The ID of the account that created the subscription. This field is automatically populated with the ID of the account that creates the subscription. - `creatorInvoiceOwnerId` string — The account ID that owns the invoices associated with the subscription or the amended subscription. - `currentTerm` integer — The length of the period for the current subscription term. - `currentTermPeriodType` 'Month' | 'Year' | 'Day' | 'Week' — The period type for the current subscription term. - `initialTerm` integer — The length of the period for the initial subscription term. - `initialTermPeriodType` 'Month' | 'Year' | 'Day' | 'Week' — The period type for the first subscription term. - `invoiceOwnerId` string — The account ID that owns the invoices associated with the subscription. - `isInvoiceSeparate` boolean — Determines if the subscription is invoiced separately. If `true`, then all charges for this subscription are collected into the subscription's own invoice. - `name` string — The name of the subscription. - `notes` string — Additional information about the subscription. - `originalCreatedDate` string — The date when the subscription was originally created. This value is the same as the `createdDate` value until the subscription is amended. - `originalId` string — The original rate plan charge ID. Only available for update subscription. - `previousSubscriptionId` string — The ID of the previous subscription. This field is only available if the subscription is a renewal subscription. - `renewalSetting` 'RENEW_WITH_SPECIFIC_TERM' | 'RENEW_TO_EVERGREEN' — Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. - `renewalTerm` integer — The length of the period for the subscription renewal term. - `renewalTermPeriodType` 'Month' | 'Year' | 'Day' | 'Week' — The period type for the subscription renewal term. - `revision` string — An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions. - `serviceActivationDate` string, date — The date on which the services or products within a subscription have been activated and access has been provided to the customer, in the `yyyy-mm-dd` format. - `status` 'Draft' | 'Pending Activation' | 'Pending Acceptance' | 'Active' | 'Cancelled' | 'Suspended' — Subscription status. - `isLatestVersion` boolean — If `true`, the current subscription object is the latest version. - `subscriptionEndDate` string, date — The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate. - `subscriptionStartDate` string, date — Date the subscription becomes effective. - `subscriptionVersionAmendmentId` string — The ID of the amendment made to this subscription version. - `termEndDate` string, date — Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). - `termStartDate` string, date — Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. - `termType` 'TERMED' | 'EVERGREEN' — The type of the subscription term. - `version` integer — This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment. - `cMRR` number — Monthly recurring revenue of the subscription. - `billToContactSnapshotId` string — The ID of the bill-to contact snapshot. - `billToContactId` string — The ID of the bill-to contact for the subscription. - `invoiceTemplateId` string — The ID of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. - `sequenceSetId` string, nullable — The ID of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. - `shipToContactId` string — The ID of the ship-to contact for the subscription. - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot. - `soldToContactId` string — The ID of the sold-to contact for the subscription. - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot. - `externallyManagedBy` 'Amazon' | 'Apple' | 'Google' | 'Roku' — An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. - `lastBookingDate` string, date — The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://docs.zuora.com?resourceId=billing-apis-subscribe-and-amend), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date. - `invoiceScheduleId` string — The ID of the invoice schedule associated with the subscription. If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule. **Note**: This field is available only if you have the Billing Schedule feature enabled. - `cancelReason` string — The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`. - `prepayment` boolean — Whether the subscription is prepaid. - `currency` string — The currency of the subscription. **Note**: This field is available only if you have the Multiple Currencies feature enabled. - `orderId` string — The ID of the order associated with the subscription. **Note**: This field is available only for orders that exist after the end of June 2023. - `rampId` string — The ID of the ramp object associated with the subscription. **Note**: This field is available only if you have the Ramp feature enabled. - `paymentTerm` string — Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices. - `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. - `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. - `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. - `opportunityCloseDate__QT` string, date - `cpqBundleJsonId__QT` string — The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. - `account` object — The subscription owner account associated with the subscription. - `invoiceOwner` object — The invoice owner account associated with the subscription. - `billToContact` object — The bill-to contact who pays the billing documents for this subscription. - `invoiceItems` object[] — The invoice items associated with the subscription. - `ratePlans` object[] — The rate plans associated with the subscription. ## Other responses - `500` — Internal server error - `4XX` — Invalid input --- [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)