CRUD: Retrieve a product rate plan charge

GET

/v1/object/product-rate-plan-charge/:id

GET

/v1/object/product-rate-plan-charge/:id

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.product_rate_plan_charges.object_get_product_rate_plan_charge(
    id="id",
)

{
  "AccountingCode": "name_1476935155610",
  "BillCycleDay": 1,
  "BillCycleType": "DefaultFromCustomer",
  "BillingPeriod": "Month",
  "BillingPeriodAlignment": "AlignToCharge",
  "BillingTiming": "In Advance",
  "ChargeModel": "Flat Fee Pricing",
  "ChargeType": "Recurring",
  "CreatedById": "2c93808457d787030157e031dd264c85",
  "CreatedDate": "2016-10-20T05:45:55.000+02:00",
  "DefaultQuantity": 1,
  "DeferredRevenueAccount": "name_1476935155610",
  "Description": "Recurring Flat Fee Pricing",
  "EndDateCondition": "SubscriptionEnd",
  "Id": "2c93808457d787030157e032002b4e21",
  "IncludedUnits": 0,
  "LegacyRevenueReporting": false,
  "ListPriceBase": "Per Billing Period",
  "Name": "Recurring_Flat Fee Pricing1476935155610",
  "NumberOfPeriod": 1,
  "OverageCalculationOption": "EndOfSmoothingPeriod",
  "OverageUnusedUnitsCreditOption": "NoCredit",
  "PriceChangeOption": "NoChange",
  "PriceIncreasePercentage": 0,
  "ProductRatePlanId": "2c93808457d787030157e031ff054e1e",
  "RecognizedRevenueAccount": "name_1476935155610",
  "RevenueRecognitionRuleName": "Recognize upon invoicing",
  "Taxable": false,
  "TriggerEvent": "ContractEffective",
  "UpToPeriodsType": "Billing Periods",
  "UpdatedById": "2c93808457d787030157e031dd264c85",
  "UpdatedDate": "2016-10-20T05:45:55.000+02:00",
  "UseTenantDefaultForPriceChange": true,
  "Formula": ""
}

Retrieves a specific product rate plan charge.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

idstringRequired

The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org 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.

Query parameters

fieldsstringOptional

Object fields to return

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

AccountingCodestringOptional<=100 characters

The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.

ApplyDiscountToenumOptional

Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.

BillCycleDayintegerOptional

Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.

Character limit: 2

Values: a valid BCD integer, 1 - 31

BillCycleTypeenumOptional

Specifies how to determine the billing day for the charge.

BillingPeriodenumOptional

The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).

BillingPeriodAlignmentenumOptional

Aligns charges within the same subscription if multiple charges begin on different dates.

Allowed values:

BillingTimingenumOptional

The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Allowed values:

ChargeFunctionenumOptional

Note: This field is only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 141 or higher. Otherwise, an error occurs.

This field defines what type of charge it is:

Standard: Normal charge with no Prepayment or Commitment or Drawdown.
Prepayment: For recurring charges. Unit or currency based prepaid charge.
CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.
Drawdown: For usage charges. Drawdown from prepaid funds.
DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.
CreditCommitment: For usage charges. Credit to minimum commitment funds.

CommitmentTypeenumOptional

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 133 or higher. Otherwise, an error occurs.

This field defines the type of commitment. A prepaid charge can be UNIT or CURRENCY. A minimum commitment(in-arrears) charge can only be CURRENCY type. For topup(recurring or one-time) charges, this field indicates what type of funds are created.

If UNIT, it will create a fund with given prepaidUom.
If CURRENCY, it will create a fund with the currency amount calculated in list price.

For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.

Allowed values:

ChargeModelenumOptional

Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.

ChargeTypeenumOptional

Specifies the type of charge.

Allowed values:

CreatedByIdstringOptional<=32 characters

The automatically generated ID of the Zuora user who created the ProductRatePlanCharge object.

CreatedDatedatetimeOptional

The date when the ProductRatePlanCharge object was created.

DefaultQuantitydoubleOptional

The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.

Character limit: 16

Values: a valid quantity value.

Note: When ChargeModel is Tiered Pricing or Volume Pricing, if this field is not specified, the value will default to 0.

DeferredRevenueAccountstringOptional<=100 characters

The name of the deferred revenue account for this charge.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

DescriptionstringOptional<=500 characters

A description of the charge.

DiscountLevelenumOptional

Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.

Allowed values:

EndDateConditionenumOptionalDefaults to SubscriptionEnd

Defines when the charge ends after the charge trigger date.

Values:

SubscriptionEnd: The charge ends on the subscription end date after a specified period based on the trigger date of the charge.
FixedPeriod: The charge ends after a specified period based on the trigger date of the charge. If you set this field to FixedPeriod, you must specify the length of the period and a period type by defining the UpToPeriods and UpToPeriodsType fields.

Note: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.

Allowed values:

ExcludeItemBillingFromRevenueAccountingbooleanOptional

The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.

Notes:

To use this field, you must set the X-Zuora-WSDL-Version request header to 115 or later. Otherwise, an error occurs.
This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

ExcludeItemBookingFromRevenueAccountingbooleanOptional

The flag to exclude the related rate plan charges and order line items from revenue accounting.

Notes:

To use this field, you must set the X-Zuora-WSDL-Version request header to 115 or later. Otherwise, an error occurs.
This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

IdstringOptional

Object identifier.

IncludedUnitsdoubleOptional

Specifies the number of units in the base set of units.

Character limit: 16

Values: a positive decimal value

LegacyRevenueReportingbooleanOptional

ListPriceBaseenumOptional

The list price base for the product rate plan charge.

Allowed values:

MaxQuantitydoubleOptional

Specifies the maximum number of units for this charge. Use this field and the MinQuantity field to create a range of units allowed in a product rate plan charge.

Character limit: 16

Values: a positive decimal value

MinQuantitydoubleOptional

Specifies the minimum number of units for this charge. Use this field and the MaxQuantity field to create a range of units allowed in a product rate plan charge.

Character limit: 16

Values: a positive decimal value

NamestringOptional<=100 characters

The name of the product rate plan charge.

NumberOfPeriodlongOptional

Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.

OverageCalculationOptionenum or nullOptional

Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored.

Values:

EndOfSmoothingPeriod: This option is used by default. The overage is charged at the end of the smoothing period.
PerBillingPeriod: The overage is charged on-demand rather than waiting until the end of the smoothing period.

Allowed values:

OverageUnusedUnitsCreditOptionenum or nullOptional

Determines whether to credit the customer with unused units of usage.

Allowed values:

PriceChangeOptionenum or nullOptionalDefaults to NoChange

Applies an automatic price change when a termed subscription is renewed.

Allowed values:

PriceIncreasePercentagedouble or nullOptional

Specifies the percentage to increase or decrease the price of a termed subscription’s renewal. Use this field if you set the value to SpecificPercentageValue.

Character limit: 16

Values: a decimal value between -100 and 100

ProductRatePlanIdstringOptional<=32 characters

The ID of the product rate plan associated with this product rate plan charge.

ProrationOptionenumOptional

Note: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge.

To use this field, you must set the X-Zuora-WSDL-Version request header to 135 or higher. Otherwise, an error occurs.

You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden.

NoProration: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
TimeBasedProration: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
DefaultFromTenantSetting: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
ChargeFullPeriod: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.

Allowed values:

RatingGroupenum or nullOptional

A rating group based on which usage records are rated. Only applicable to Usage charges.

Possible values:

ByBillingPeriod: The rating is based on all the usages in a billing period.
ByUsageStartDate: The rating is based on all the usages on the same usage start date.
ByUsageRecord: The rating is based on each usage record.
ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv).
ByGroupId: The rating is based on all the usages in a custom group.

For more information, see Usage rating by group.

Allowed values:

RecognizedRevenueAccountstringOptional<=100 characters

The name of the recognized revenue account for this charge.

Required when the Allow Blank Accounting Code setting is No.
Optional when the Allow Blank Accounting Code setting is Yes.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

RevRecCodestring or nullOptional<=70 characters

Associates this product rate plan charge with a specific revenue recognition code.

RevRecTriggerConditionenum or nullOptional

Specifies when revenue recognition begins.

Allowed values:

RevenueRecognitionRuleNameenumOptional

Determines when to recognize the revenue for this charge.

Allowed values:

SmoothingModelenum or nullOptional

Specifies the smoothing model for an overage smoothing charge model.

Allowed values:

SpecificBillingPeriodlong or nullOptional

Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to Specific Months or Specific Weeks. The valid value is a positive integer.

SpecificListPriceBaseinteger or nullOptional

The number of months for the list price base of the charge. The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months.

Notes:

This field is available only if you have the Annual List Price feature enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 129 or later. Otherwise, an error occurs.
The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months.

TaxCodestringOptional<=64 characters

Specifies the tax code for taxation rules. Required when the Taxable field is set to True.

Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge.

TaxModeenum or nullOptional

Determines how to define taxation for the charge. Required when the Taxable field is set to True.

Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge.

Allowed values:

TaxablebooleanOptional

Determines whether the charge is taxable. When set to True, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.

Character limit: 5

Values: True, False

Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge.

TriggerEventenumOptional

Specifies when to start billing the customer for the charge.

Values:

ContractEffective is the date when the subscription’s contract goes into effect and the charge is ready to be billed.
ServiceActivation is the date when the services or products for a subscription have been activated and the customers have access.
CustomerAcceptance is when the customer accepts the services or products for a subscription.

Allowed values:

UOMstring or nullOptional<=25 characters

Specifies the units to measure usage.

Note: You must specify this field when creating the following charge models:

Per Unit Pricing
Volume Pricin
Overage Pricing
Tiered Pricing
Tiered with Overage Pricing

UpToPeriodslong or nullOptional

Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.

Character limit: 5

Values: a whole number between 0 and 65535, exclusive

Notes:

You must use this field together with the UpToPeriodsType field to specify the time period. This field is applicable only when the EndDateCondition field is set to FixedPeriod.
If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.

UpToPeriodsTypeenum or nullOptionalDefaults to Billing Periods

The period type used to define when the charge ends.

Notes:

You must use this field together with the UpToPeriods field to specify the time period.
This field is applicable only when the EndDateCondition field is set to FixedPeriod.

Allowed values:

UpdatedByIdstringOptional<=32 characters

The ID of the last user to update the object.

UpdatedDatedatetimeOptional

The date when the object was last updated.

UseDiscountSpecificAccountingCodeboolean or nullOptional

Determines whether to define a new accounting code for the new discount charge.

Character limit: 5

Values: True, False

UseTenantDefaultForPriceChangebooleanOptional

Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription’s renewal.

Character limit: 5

Values: true, false

WeeklyBillCycleDayenumOptional

Specifies which day of the week as the bill cycle day (BCD) for the charge.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

IsAllocationEligiblebooleanOptional

Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is False.

Values: True, False

Notes:

The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

IsUnbilledbooleanOptional

Specifies how to perform the accounting during revenue recognition. The default value is False.

Values: True, False

Notes:

The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

ProductCategorystringOptional

This field is used to maintain the product category for integration with Zuora Revenue.

Notes:

This field is available only if you have the Additional Revenue Fields property enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

ProductClassstringOptional

This field is used to maintain the product class for integration with Zuora Revenue.

Notes:

This field is available only if you have the Additional Revenue Fields property enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

ProductFamilystringOptional

This field is used to maintain the product family for integration with Zuora Revenue.

Notes:

This field is available only if you have the Additional Revenue Fields property enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

ProductLinestringOptional

This field is used to maintain the product line for integration with Zuora Revenue.

Notes:

This field is available only if you have the Additional Revenue Fields property enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

ReflectDiscountInNetAmountbooleanOptionalDefaults to false

When you apply percentage discounts to either of the following charges, you need to set the ReflectDiscountInNetAmount field on your discount charge to true, to enable calculating and displaying the net amount of the following charges in Zuora Revenue.

delivery pricing charge
prepayment charge
drawdown charge

Note the following:

If you are an Order to Revenue customer, when you set the ReflectDiscountInNetAmount field to true, you must also set both the ExcludeItemBookingFromRevenueAccounting and ExcludeItemBillingFromRevenueAccounting fields to true.
If you are a Billing - Revenue Integration customer, you must set the ReflectDiscountInNetAmount field to false, otherwise an error will be returned. Billing - Revenue Integration customers are not supported with net amount.
If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the ReflectDiscountInNetAmount field to true.

RevenueRecognitionTimingenumOptional

Specifies the type of revenue recognition timing.

Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI.

Note: This field is only available if you have the Order to Revenue feature enabled.

Allowed values:

RevenueAmortizationMethodenumOptional

Specifies the type of revenue amortization method.

Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI.

Note: This field is only available if you have the Order to Revenue feature enabled.

Allowed values:

ApplyToBillingPeriodPartiallybooleanOptional

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discount feature to access this field.

FormulastringOptional

The price lookup formula defined for the product rate plan charge, which is used to identify the correct and relevant charge definition based on the context.

For more information, see Price lookup in Attribute-based Pricing.

Notes:

This field is available only if the Attribute-based Pricing feature is enabled.
To use this field, you must set the X-Zuora-WSDL-Version request header to 138 or higher.

Class__NSstringOptional<=255 characters

Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

DeferredRevAccount__NSstringOptional<=255 characters

Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Department__NSstringOptional<=255 characters

Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IncludeChildren__NSenumOptional

Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the Zuora Connector for NetSuite.

Allowed values:

IntegrationId__NSstringOptional<=255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstringOptional<=255 characters

Status of the product rate plan charge’s synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

ItemType__NSenumOptional

Type of item that is created in NetSuite for the product rate plan charge. Only available if you have installed the Zuora Connector for NetSuite.

Allowed values:

Location__NSstringOptional<=255 characters

Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

RecognizedRevAccount__NSstringOptional<=255 characters

Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

RevRecEnd__NSenumOptional

End date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Allowed values:

RevRecStart__NSenumOptional

Start date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Allowed values:

RevRecTemplateType__NSstringOptional<=255 characters

Only available if you have installed the Zuora Connector for NetSuite.

Subsidiary__NSstringOptional<=255 characters

Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstringOptional<=255 characters

Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Errors

401

Unauthorized Error

404

Not Found Error