---
title: "Retrieve a rating detail"
method: GET
path: "/object-query/rating-details/{key}"
tags: ["Object Queries"]
---

# Retrieve a rating detail

`GET /object-query/rating-details/{key}`

Retrieves a single rating detail by ID.

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

## Response `200`

OK

- RatingDetails
  - `id` string — The unique identifier of the Rating Detail.
  - `invoiceItemId` string — The unique identifier of the Invoice Item this Rating Detail is associated to.
  - `creditMemoItemId` string, nullable — The unique identifier of the Credit Memo Item this Rating Detail is associated to.
  - `chargeType` string — The type of charge of the associated Invoice Item.
  - `chargeModel` string — The charge model of the associated Invoice Item.
  - `formula` string — Text with mathematical formula used to rate the amount.
  - `calculation` string — Details of the rating done by replacing values in the formula.
  - `calculatedAmount` number, double — The output result of the rating calculation.
  - `currency` string — The currency code of the calculated amount.
  - `unitOfMeasure` string — Unit of measure if it's a usage charge.
  - `quantity` number, double, nullable — If usage charge, quantity of usages.
  - `billedQuantity` number, double, nullable — For on-demand usage charges, previously billed quantity in the same billing period.
  - `billedAmount` number, double, nullable — For on-demand usage charges, previously billed amount in the same billing period.
  - `isProration` boolean — True if the billing period is a prorated period.
  - `isCredit` boolean — True if this is a credit.
  - `listPriceBase` string — List price base from the rate plan charge.
  - `billingCycleDay` integer — Billing cycle day from the rate plan charge.
  - `billingCycleType` string — Billing cycle type from the rate plan charge.
  - `billingPeriod` string — Billing period from the rate plan charge.
  - `specificBillingPeriod` string — Specific billing period from the rate plan charge.
  - `validityPeriodType` string — Validity period type for prepaid or commitment charges.
  - `billingPeriodAlignment` string — Billing period alignment from the rate plan charge.
  - `alignmentStartDate` string, date — Start date used for billing alignment.
  - `amountWithoutTax` number, double — The amount from the Invoice Item or Credit Memo Item.
  - `isInclusiveTaxNoRounding` boolean — True if tax mode option is set to tax inclusive.
  - `isProrationPartialPeriod` boolean — True if billing rule "Prorate recurring charges for partial period?" is Yes.
  - `isProrateMonthlyCharges` boolean — True if billing rule "Bill usage/recurring charges for partial month?" is Yes.
  - `isProrateWeeklyCharges` boolean — True if billing rule "Bill usage/recurring charges for partial week?" is Yes.
  - `prorationUnitRule` string — Value of billing rule for prorating units.
  - `daysInMonthRule` string — Value of billing rule for days in a month.
  - `recurringCreditProrationOptionRule` string — Billing rule for recurring credit proration option.
  - `isCreditWithOriginalCE` boolean — True if permission for credit with original invoice item amount is enabled.
  - `isProrateDiscountCredit` boolean — True if prorated discount credit rule is enabled.
  - `stackedDiscountClassApplyRule` string — Billing rule for applying stacked discount class.
  - `recurringPeriodStart` string, date — Start date of the current service period.
  - `recurringPeriodEnd` string, date — End date of the current service period.
  - `chargeStartDate` string, date — Charge start date.
  - `chargeEndDate` string, date — Charge end date.
  - `subStartDate` string, date — Subscription start date.
  - `subEndDate` string, date — Subscription end date.
  - `termStartDate` string, date — Term start date.
  - `termEndDate` string, date — Term end date.
  - `creditOption` string — Credit option from the rate plan charge.
  - `fundingPrice` number, double — Total price of current validity period fund.
  - `totalBalance` number, double — Total fund or discount schedule balance.
  - `remainingBalance` number, double — Remaining fund or discount schedule balance.
  - `originalBillingPeriodStart` string, date — Start date of original billing period if credit.
  - `originalBillingPeriodEnd` string, date — End date of original billing period if credit.
  - `originalAmount` number, double — Original billed amount if credit.
  - `basePrice` number, double — Base price or fixed amount.
  - `discountClass` string — Discount class as in rate plan charge.
  - `discountClassOrder` integer — Order number of discount class.
  - `discountLevel` string — Discount level from rate plan charge.
  - `discountApplySequence` integer — Sequence in which the discount is applied.
  - `discountSchedulePeriodStart` string, date — Discount schedule start date.
  - `discountSchedulePeriodEnd` string, date — Discount schedule end date.
  - `regularChargeAmount` number, double — Amount of the charge that the discount is applied to.
  - `regularChargeAmountLeft` number, double — Remaining amount of charge before this discount is applied.
  - `originalRegularChargeAmount` number, double — Original amount of charge before credit.
  - `discountBalanceFormula` string — Formula used to calculate discount total balance.

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