Sign in
Object Queries

Retrieve a rating detail

Retrieves a single rating detail by ID.

get/object-query/rating-details/{key}

Path parameters

keystring required

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. id.ASC) or descending (e.g. id.DESC). Supported sortable fields:

  • id
  • invoiceitemid
  • creditmemoitemid
expand[]string[]

Allows you to expand responses by including related object information in a single call. This operation does not have expandable fields.

filter[]string[]

A case-insensitive filter on the list.

Supported filterable fields:

  • id
  • invoiceitemid
  • creditmemoitemid

You can also filter on custom fields using the format customField__c.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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

Response

OK

idstring

The unique identifier of the Rating Detail.

invoiceItemIdstring

The unique identifier of the Invoice Item this Rating Detail is associated to.

creditMemoItemIdstring nullable

The unique identifier of the Credit Memo Item this Rating Detail is associated to.

chargeTypestring

The type of charge of the associated Invoice Item.

chargeModelstring

The charge model of the associated Invoice Item.

formulastring

Text with mathematical formula used to rate the amount.

calculationstring

Details of the rating done by replacing values in the formula.

calculatedAmountnumber double

The output result of the rating calculation.

currencystring

The currency code of the calculated amount.

unitOfMeasurestring

Unit of measure if it's a usage charge.

quantitynumber double nullable

If usage charge, quantity of usages.

billedQuantitynumber double nullable

For on-demand usage charges, previously billed quantity in the same billing period.

billedAmountnumber double nullable

For on-demand usage charges, previously billed amount in the same billing period.

isProrationboolean

True if the billing period is a prorated period.

isCreditboolean

True if this is a credit.

listPriceBasestring

List price base from the rate plan charge.

billingCycleDayinteger

Billing cycle day from the rate plan charge.

billingCycleTypestring

Billing cycle type from the rate plan charge.

billingPeriodstring

Billing period from the rate plan charge.

specificBillingPeriodstring

Specific billing period from the rate plan charge.

validityPeriodTypestring

Validity period type for prepaid or commitment charges.

billingPeriodAlignmentstring

Billing period alignment from the rate plan charge.

alignmentStartDatestring date

Start date used for billing alignment.

amountWithoutTaxnumber double

The amount from the Invoice Item or Credit Memo Item.

isInclusiveTaxNoRoundingboolean

True if tax mode option is set to tax inclusive.

isProrationPartialPeriodboolean

True if billing rule "Prorate recurring charges for partial period?" is Yes.

isProrateMonthlyChargesboolean

True if billing rule "Bill usage/recurring charges for partial month?" is Yes.

isProrateWeeklyChargesboolean

True if billing rule "Bill usage/recurring charges for partial week?" is Yes.

prorationUnitRulestring

Value of billing rule for prorating units.

daysInMonthRulestring

Value of billing rule for days in a month.

recurringCreditProrationOptionRulestring

Billing rule for recurring credit proration option.

isCreditWithOriginalCEboolean

True if permission for credit with original invoice item amount is enabled.

isProrateDiscountCreditboolean

True if prorated discount credit rule is enabled.

stackedDiscountClassApplyRulestring

Billing rule for applying stacked discount class.

recurringPeriodStartstring date

Start date of the current service period.

recurringPeriodEndstring date

End date of the current service period.

chargeStartDatestring date

Charge start date.

chargeEndDatestring date

Charge end date.

subStartDatestring date

Subscription start date.

subEndDatestring date

Subscription end date.

termStartDatestring date

Term start date.

termEndDatestring date

Term end date.

creditOptionstring

Credit option from the rate plan charge.

fundingPricenumber double

Total price of current validity period fund.

totalBalancenumber double

Total fund or discount schedule balance.

remainingBalancenumber double

Remaining fund or discount schedule balance.

originalBillingPeriodStartstring date

Start date of original billing period if credit.

originalBillingPeriodEndstring date

End date of original billing period if credit.

originalAmountnumber double

Original billed amount if credit.

basePricenumber double

Base price or fixed amount.

discountClassstring

Discount class as in rate plan charge.

discountClassOrderinteger

Order number of discount class.

discountLevelstring

Discount level from rate plan charge.

discountApplySequenceinteger

Sequence in which the discount is applied.

discountSchedulePeriodStartstring date

Discount schedule start date.

discountSchedulePeriodEndstring date

Discount schedule end date.

regularChargeAmountnumber double

Amount of the charge that the discount is applied to.

regularChargeAmountLeftnumber double

Remaining amount of charge before this discount is applied.

originalRegularChargeAmountnumber double

Original amount of charge before credit.

discountBalanceFormulastring

Formula used to calculate discount total balance.

Changes