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

e.g., 9c4867ed55db43a89731605d5654d4ed

string

A new display name for the charge.

string

sting

Trigger Event

The event that triggers the charge, if updates are supported.

string

e.g., Each, Seats, License.

string

integer

The minimum allowed quantity, if supported.

integer

The maximum allowed quantity, if supported.

integer

e.g., Per_Billing_Period.

string

e.g., default_from_customer or specific_day_of_month.

string

integer

The day of the week to bill when using a weekly billing mode.

string

Bill Cycle > Period

e.g., bill_cycle_period_month, bill_cycle_period_quarter.

string

Bill Cycle > Specific Period

The custom billing period text, if applicable.

string

Bill Cycle > Period Alignment

e.g., align_to_charge or align_to_term_start.

string

enum: in_advance , in_arrears.

string

A mapping of currencies to their corresponding flat amounts.

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

object

additional property

integer

array of objects

A name for the Attribute name.

e.g., Age, Region, EffectiveDate.

string

Comparison operator used to evaluate the condition.

enum: >, >=, <, <=, ==, between, between-inclusive.

string

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

string, integer, boolean, arry of strings.

Maps each currency code to its corresponding flat amount.

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

object

Any additional property

integer

Tax code to associate with the charge.

string

Tax mode to apply to the price, if supported.

e.g., tax_exclusive or non_taxable).

string

Specifies how price changes are applied when the charge is updated.

e.g., no_change.

string

If true, tenant defaults govern price change behavior.

boolean

Configuration for delivery by day of the week, if delivery scheduling is enabled.

object

Prepayment configuration, including credit options, rollover, and validity settings.

object

Indicates whether the charge is prepaid.

boolen

Overage configuration for usage charges.

object

Accounting > Accounting Code

Accounting code associated with the charge for reporting and ERP mapping. Typically a short code or identifier, rather than the general ledger (GL) account name.

e.g., PRPC-REV-001

string

Accounting > ​Accounts Receivable Account

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

string

Accounting > Accounts Receivable Account Type

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

string

Accounting > Deferred Revenue Accounting

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

string <= 100 characters

Accounting > Deferred Revenue Accounting Type

Accounting method applied to deferred revenue. Maps to the deferredRevenueAccountingType field in the accounting object.

string

Accounting > Recognized Revenue Account

Name of the account whose account type is Recognized Revenue. The account must exist in the tenant's chart of accounts.e.g.

ContractRevRec-1

string <= 100 characters

Accounting > Recognized Revenue Account Type

Account type associated with the recognized_revenue_account. Maps to the recognizedRevenueAccountType field in the accounting object.

string

Accounting > Adjustment Liability Account

Name of the account whose account type is Adjustment Liability. The account must exist in the tenant's chart of accounts.e.g.

adjustL-1

string <= 100 characters

Accounting > Adjustment Liability Account Type

Account type associated with the adjustment_liability_account. Maps to the adjustmentLiabilityAccountType field in the accounting object.

string

Accounting > Adjustment Revenue Account

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

e.g. adjustRev-1

string <= 100 characters

Accounting > Adjustment Revenue Account Type

Account type associated with the adjustment_revenue_account. Maps to the adjustmentRevenueAccountType field in the accounting object.

string

​Accounting > Contract Asset Account

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

e.g., CA-2

string

Accounting ​> Contract Asset Account Type

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

string

Accounting > Contract Liability Account

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

e.g., CL-2

string <= 100 characters

​Accounting > Contract Liability Account Type

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

string

Accounting > Contract Recognized Revenue Account

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

string

Accounting > Contract Recognized Revenue Account Type

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

string

Accounting > Unbilled Receivables Account

Name of the account whose account type is Unbilled Receivables.

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 > ​Property Name*

Revenue recognition settings.

object

​Netsuite > Property Name*

NetSuite integration attributes for the charge.

object

Custom Fields > ​Property Name*

Tenant-specific custom field values on the charge.

object

Labels > Property Name*

Free-form labels/tags attached to the charge.

object

organization labels

Organization-level labels associated with the charge.

array of objects

ocm json by currency. > Property Name*

Any additional property.

object

Attributes > ​Name*

Name of the attribute.

e.g., Region, Age, EffectiveDate.

string

Attributes ​> Type

Data type of the attribute.

Enum: string, integer, double, boolean, date, datetime.

string

Target object

e.g., account, subscription.

string

Field on the target object.

e.g., age__c.

string