Retrieve a product charge definition

Retrieves basic information about a product charge definition.

Note: This operation requires the Attribute-based Pricing feature to be enabled, which is in the Early Adopter phase.

Request
path Parameters
product-charge-definition-key
required
string

The unique number or ID of the product charge definition to be retrieved.

query Parameters
hide-inherited-values
boolean

The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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.

Responses
200
500

Internal Server Error

4XX

Request Errors

get/v1/product-charge-definitions/{product-charge-definition-key}
Request samples 
Response samples 
application/json
{
  • "applyDiscountTo": null,
  • "billingDay": "DefaultFromCustomer",
  • "billingPeriod": "Month",
  • "billingPeriodAlignment": "AlignToCharge",
  • "billingTiming": "IN_ADVANCE",
  • "chargeModel": "FlatFee",
  • "defaultQuantity": 1,
  • "deliverySchedule": null,
  • "description": "",
  • "discountClass": null,
  • "discountLevel": null,
  • "effectiveEndDate": "2023-10-13 09:00:00",
  • "effectiveStartDate": "2022-10-07 09:00:00",
  • "endDateCondition": "Subscription_End",
  • "financeInformation": {
    },
  • "isDefault": true,
  • "isStackedDiscount": false,
  • "listPriceBase": "Per_Billing_Period",
  • "numberOfPeriods": null,
  • "overageCalculationOption": null,
  • "overageUnusedUnitsCreditOption": null,
  • "priceChangeOption": null,
  • "priceIncreasePercentage": null,
  • "prices": [
    ],
  • "productChargeDefinitionId": "2c9890f78b0d09d2018b0d13c7fd0004",
  • "productChargeDefinitionNumber": "CD-00000201",
  • "productDiscountApplyDetails": [ ],
  • "productRatePlanChargeId": "2c9890f78b0d09d2018b0d13c7fd0004",
  • "productRatePlanChargeNumber": null,
  • "productRatePlanId": null,
  • "productRatePlanName": null,
  • "productRatePlanNumber": null,
  • "ratingGroup": null,
  • "revRecCode": null,
  • "revRecTriggerCondition": null,
  • "revenueRecognitionRuleName": "Recognize upon invoicing",
  • "smoothingModel": null,
  • "specificBillingPeriod": null,
  • "specificListPriceBase": null,
  • "success": true,
  • "taxCode": "",
  • "taxMode": null,
  • "taxable": false,
  • "term": null,
  • "termPeriodType": null,
  • "termType": null,
  • "triggerEvent": "ContractEffective",
  • "uom": null,
  • "upToPeriods": null,
  • "upToPeriodsType": null,
  • "usageRecordRatingOption": null,
  • "useDiscountSpecificAccountingCode": null,
  • "useTenantDefaultForPriceChange": true
}