IsNewProductRatePlanCharge

Required when creating a new product rate plan charge. Enter True if applicable; otherwise, enter False. This field cannot be left blank.

true of false

Enum: flat_fee, per_unit, overage, volume, tiered, tiered_overage, discount_fixed_amount, discount_percentage, custom_charge_model, delivery, minimum_commitment_true_up, calculated, high_water_mark_volume_pricing, high_water_mark_tiered_pricing, multi_attribute_pricing, prerated_pricing, prerated_per_unit

string

Enum: one_time, recurring, usage.

string

string

string

string

double

Enum: end_date_one_time, subscription_end, fixed_period, specific_end_date.

string

Number of periods used with end_date_condition = fixed_period. Combined with up_to_periods_type to determine the fixed duration of the charge. Ignored when end_date_condition = subscription_end.

integer 32

Enum: billing_periods, days, weeks, months, years.

sting

Enum: default_from_customer, specific_day_of_month, subscription_start_day, charge_trigger_day, specific_day_of_week, term_start_day, term_end_day.

string

Enum: bill_cycle_period_month, bill_cycle_period_quarter, bill_cycle_period_semi_annual, bill_cycle_period_annual, bill_cycle_period_eighteen_months, bill_cycle_period_two_years, bill_cycle_period_three_years, bill_cycle_period_five_years, bill_cycle_period_specific_months, bill_cycle_period_subscription_term, bill_cycle_period_week, bill_cycle_period_specific_weeks, bill_cycle_period_specific_days.

string

Enum: align_to_charge, align_to_subscription_start, align_to_term_start, align_to_term_end.

string

Specifies whether the charge is billed before or after the service period.

Enum: in_advance, in_arrears.

string

Specifies the day of the week.

Enum:sunday, monday, tuesday, wednesday, thursday, friday, saturday.

string

Required when type is specific_day_of_month.

string

Enum: Per_Billing_Period, Per_Month, E, Per_Year, Per_Specific_Months, Per_Validity_Period.

string

e.g., 0

double

Specifies the event that activates the charge on a subscription.

Enum: contract_effective, service_activation, customer_acceptance, specific_date.

string

Identifier of the product rate plan that owns this charge.

string

Formula applied after rate-card lookup to adjust the computed price.

String

Tax code used for tax calculation on this charge.

string

Tax mode for this charge.

Enum: non_taxable, tax_exclusive, tax_inclusive.

string

Accounting code associated with the charge for reporting and ERP mapping. This is a code or identifier, not the general ledger (GL) account name.

string

Name of the Accounts Receivable (AR) account used to record invoices for this charge. The account must exist in the tenant's chart of accounts.

e.g., Accounts Receivable

sting

Account type associated with the accounts_receivable_account. Maps to the accountsReceivableAccountType field in the accounting object.

sting

Name of the deferred revenue (liability) account used to record revenue before it is recognized. The account must exist in the tenant's chart of accounts.

e.g.,Deferred Revenue

sting

sting

e.g.ContractRevRec-1

sting <= 100 characters

sting

Name of the account whose account type is Adjustment Liability.

e.g.,adjustL-1

sting <= 100 characters

sting

e.g., adjustRev-1

sting <= 100 characters

sting

e.g., CA-2

sting <= 100 characters

Account type associated with the contract_asset_account. Maps to the contractAssetAccountType field in the accounting object.

sting

Name of the account whose account type is Contract Liability.

e.g.,Contract Recognized Revenue

sting <= 100 characters

Account type associated with the contract_liability_account. Maps to the contractLiabilityAccountType field in the accounting object.

sting

Name of the recognized revenue account used for contract-based revenue recognition. The account must exist in the tenant's chart of accounts.

e.g.,Contract Recognized Revenue

sting

Account type associated with the contract_recognized_revenue_account. Maps to the contractRecognizedRevenueAccountType field in the accounting object.

sting

Accounting > ​Unbilled Receivables Account

Name of the account whose account type is Unbilled Receivables. The account must exist in the tenant's chart of accounts.

e.g.,unbilledR-1

string <= 100 characters

Accounting >​ Unbilled Receivables Account Type

Account type associated with the unbilled_receivables_account. Maps to the unbilledReceivablesAccountType field in the accounting object.

string

Revenue recognition configuration, .

object

Tenant custom fields on the charge.

object

Name of the attribute.

e.g., Age, Region, EffectiveDate

sting

Data type of the attribute.

string

Name of the Zuora object from which to retrieve the attribute value.

e.g., account , subscription

string

Name of the field on the target object.

e.g., age__c

sting

Map of currency to flat amount.

e.g., {"USD":100}.

object

Any additional property.

integer

Name of the attribute used in the condition.

e.g., Age, Region, EffectiveDate.

string

Comparison operator used to evaluate the condition.

enum:>>=<<===betweenbetween-inclusive

string

Comparison value used to evaluate the condition. The value must match the attribute's declared data type. For between and between-inclusive, provide an array of exactly two string or number values representing the range.

e.g., One of:stringnumberbooleanArray of strings or numbersComparison value. For between, provide an array of two values. The value type must align with the attribute's declared type.

string

Map of currency to flat amount.

e.g., {"USD":100}.

object

Any additional property.

Integer