# Save Rating Method

Save Rating Method

Endpoint: POST /rest/2.0/RATING_METHOD
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.QuoteProductDraftId` (integer)
    QuoteProductDraftId

  - `brmObjects.QuoteProductId` (integer)
    QuoteProductId

  - `brmObjects.CalculateEffectiveRate` (integer)
    Calculate Effective Rate

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.RatingMethodType` (string)
    Rating Method: Specifies the rating method applied to the product. See the Rating Methods Overview topic for more information.

  - `brmObjects.Id` (string, required)
    Id

  - `brmObjects.PricingType` (string)
    Pricing Type: Indicates the type of pricing that the product will use. Available options are:	Standard Pricing: Specify the rate in currencies configured on the platform. This is the basic per usage unit charge.	Tiered Pricing: Specify tiered rates. This enables the flexibility of indicating different rates based on the number of usage units.

  - `brmObjects.ProrateSubscription` (string)
    Prorate Subscription Charges: Indicates whether the charge for the subscription is for the whole amount or pro-rated if it is activated in the middle of the customer's billing cycle.

  - `brmObjects.SubscriptionModel` (string)
    Payment Model: Indicates when the subscription charges are reflected on the customer's invoice. Available options are:	Postpaid: (Default Option) Results in the subscription charge being displayed on the customer's invoice after the subscription dates have taken place.	Prepaid: Results in the charge appearing on customer's invoices before the subscription dates have taken place.

  - `brmObjects.AggregateRateType` (string)
    Tiered Rate Type: Allows for choosing the behavior of how usage data is handled for tier rates. Available choices are:	Bulk: Applies the rate of the final tier to all the usage units.	Incremental: Applies the rate for usage allocated to each tier respectively.	Block: Applies the rate for usage using the number of iterations and block size specified for each tier. The usage is divided by the block size and the result is multiplied by the rate. The number of iterations becomes the threshold for the tier.

  - `brmObjects.IntervalSubscriptionDays` (string)
    Interval (Days): Enter the number of days that must lapse until the customer is billed again.

  - `brmObjects.IncrementAmount` (string)
    IncrementAmount

  - `brmObjects.ExcludeComponents` (string)
    ExcludeComponents

  - `brmObjects.SplitUsage` (integer)
    Split Usage Crossing Bands: When dealing with large chunks of data, enabling this option will allow the splitting of usage data across bands. Disabling the option will have the large chunk rated against the lower band.

  - `brmObjects.PropagateInvLevelCharge` (integer)
    Propagate Charges to Hierarchy: When this flag is checked the product charge will be applied to all accounts in the system regardless if the product is included as part of the account product or account package product.

  - `brmObjects.CycleType` (string)
    Cycle Context: Indicates when the charge is applied relative to the customer's billing cycle: Sync with Service Start Date: Charge is applied on the day the product or service is provisioned. Sync with Billing Cycle: (Default) Charge is applied at the start of the billing cycle.

  - `brmObjects.ActivationChargePlace` (string)
    Initial Invoice Creation: Indicates when the invoice will be created to cover the new subscription. Available options are:	Create Activation Invoice for New Customers: (Default Option) Invoice is immediately created for a customer when the subscription being added is the first one for the said customer.	Always Create Activation Invoice: Invoice is immediately created for a customer regardless if it is the first subscription or not.	Use Billing Cycle Invoice: Invoice is not generated immediately and all subscription charges are included in the standard invoice of the customer (e.g. included in the next billing cycle).

  - `brmObjects.LateFeeType` (string)
    Late Fee Type: Indicates the manner of adding the late fee to the invoice that is being closed. Available options are:			Percentage: (Default Option) The percentage of the past due balance will be taken and added to the overall amount. The behavior is further influenced by the Late Fee Against Balance field.		Fixed Fee: A flat fee will be added to the invoice regardless of the amount and age of the unpaid balance.

  - `brmObjects.LateFeeAgainstBalance` (string)
    Late Fee Against Balance: Late Fee Against Balance	Indicates the multiplier/factor that will be used to compute with the late fee percentage. Available options are:			Last Bill Cycle: (Default Option) The last balance due from the last billing cycle will be taken when computing for the percentage.		Total Late Balance: The total unpaid balance due from all previous billing cycles will be taken when computing for the percentage.		Annual Percentage Rate: The number of late days will be used as the factor for getting the percentage.

  - `brmObjects.SubAggrLevel` (string)
    Shared Across: Indicates which overage information will be monitored and rated. Available options are:			Account: (Default Option) Usage routed to any product in the account will be rated if defined in the Overage Component table.		Package: Usage routed to any product in the package where the subscription exists will be rated if defined in the Overage Component table		Invoice: Any usage in the invoice that is specified in the Overage Component table under any subscription on that invoice will be rated.		Custom Affiliation: option presents a filter to identify billing activities consuming included quantities.

  - `brmObjects.DiscountApplMethod` (string)
    Application Method

  - `brmObjects.DiscountEligUnitMeas` (string)
    Units of Measure for Eligible Charges

  - `brmObjects.FormulaParamIdent` (string)
    Formula Parameter Identifier

  - `brmObjects.TaxApplication` (string)
    Tax Application: Indicates where the amount will be taken from and will be used for tax computation. Available options are:			Per Invoice: (Default Option) Amount to be computed for tax will be taken from the total invoice amount.		Per Product: Amount to be computed for tax will be taken from the products in the invoice.

  - `brmObjects.ChargeType` (string)
    Charge Type: Choose how to apply the Fee or Surcharge: Per Invoice: (Default) Adds a fixed amount to the invoice regardless of the total amount. Percentage: Calculates the fee or surcharge as a percentage of the invoice total.

  - `brmObjects.FormulaValue` (string)
    Formula Cost: Refer to the Formula Value Calculation help topic for more information.

  - `brmObjects.ApplyChargeOnComponent` (integer)
    Apply Charge on Component: Indicate the product/component that will trigger the application of the charge.

  - `brmObjects.DiscountPriority` (string)
    Discount Priority

  - `brmObjects.DiscountApplyTo` (string)
    Apply To

  - `brmObjects.NumberOfCharges` (string)
    NumberOfCharges

  - `brmObjects.DiscountEligCond` (string)
    DiscountEligCond

  - `brmObjects.DefaultRateFlag` (integer)
    DefaultRateFlag

  - `brmObjects.DiscountItemize` (integer)
    Itemize Discount: Specifies if the discount is applied to all products that are eligible for the discount on the invoice or not.			Checked: Discount will be applied to all occurrences of the eligible product that appears on the invoice.		Unchecked: (Default Option) The discount will apply on the invoice once.

  - `brmObjects.SubscriptionCycle` (string)
    Subscription Cycle: Indicates the renewal/charging cycle of the subscription

  - `brmObjects.EarlyTerminationOption` (string)
    Early Termination Option: Specifies the behavior of a subscription when it ends early. Prorate Current Invoice: (Default) If the related invoice is not closed, the last subscription charge is prorated. If the related invoice is closed, a credit note for the subscription charges is not created. Credit: If the related invoice is not closed, the last subscription charge is prorated. If the related invoice is closed, a credit note for the subscription charges is created.

  - `brmObjects.ProrateCreditAfterPeriod` (string)
    Prorate Credit After Period (Days)

  - `brmObjects.TaxType` (string)
    Tax Type: Indicates the manner of adding the tax product will be applied. The amount on which the tax will be applied will also be influenced by the Tax Application field. Available options are:			Percentage: (Default Option) The percentage of the amount will be taken.		Fixed or Flat Fee: A flat fee will be added to the invoice regardless of the amount.

  - `brmObjects.OverrideTypePackage` (integer)
    OverrideTypePackage

  - `brmObjects.DiscountLimitedUsage` (integer)
    Limited Usage: Indicates if the discount can be used a limited number of times instead of perpetual.			Checked: Discount can be used a limited number of times.		Unchecked: (Default Option) Discount can be used perpetually whenever there are eligible charges.

  - `brmObjects.DiscountMaxNumberOfUses` (string)
    Max Number of Uses: Enter the maximum number of times Trial can be applied.

  - `brmObjects.DiscountUsePer` (string)
    Use Per: Only applicable when Limited Usage is checked.			Invoice: (Default Option) The limited use counter is decremented once per invoice.		Item: The limited use counter is decremented for each instance of an eligible product on the invoice.

  - `brmObjects.FlatRate` (integer)
    Use Tier Price as Flat Rate: Setting Flat Rate flag will price the activity at a flat rate of a tier, without multiplying the rate by the cost. In case of the Incremental pricing the cost of each tier < quantity of rated activity will be added up for final cost. In case of the Bulk pricing only one flat rate will be used based on the corresponding tier for quantity on activity.

  - `brmObjects.formulaOnInvoiceClose` (integer)
    On Invoice Close: Setting on Invoice Close flag will trigger the system to evaluate the records (or groups of records if Group Identifier is specified) and create a record for every formula evaluation meeting the condition.

  - `brmObjects.commitmentApplicableProduct` (string)
    commitmentApplicableProduct: Applicable Product for Minimum Commitment

  - `brmObjects.TaxApplicableTo` (string)
    Applicable To: Select if the tax should apply to all the products or just a subset based on the filter criteria

  - `brmObjects.TaxProductFilterLogic` (string)
    Filtered Products Join Logic: Use this to define logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. In case you have 3 filters you can use this field to define more meaning accross the three. For example: (1 AND 2) OR 3. Use parentheses as well as AND and OR operator to define the filter logic.

  - `brmObjects.ForbidChargeInPreviousPeriod` (integer)
    ForbidChargeInPreviousPeriod

  - `brmObjects.AutoRefill` (integer)
    Auto Refill: Indicates if a new prepaid usage product charge is generated and invoiced to the customer when the linked usage quantity is used up. If left unchecked, the prepaid usage product will not generate a new charge and the linked usage product will be invoiced using the active rate. When checked, a new prepaid product charge is generated and the included 'free' usage is added to the linked overage product

  - `brmObjects.ZeroRatedDisplayFlag` (string)
    Display Zero-rated Components on Invoice

  - `brmObjects.ObligatoryIntlRate` (integer)
    Raise Alert on Missing International Rate: Select to enable a system alert when the international rate is missing. If deselected, the system substitutes the product's default rate for the missing international rate.

  - `brmObjects.TrialTarget` (string)
    Products Eligible for Trial: Indicates which products are eligible for Trial and to which products rate reduction will be applied.

  - `brmObjects.TrialUsePer` (string)
    Use Per: Indicates if the  Max Number of Uses from application Trial discount or rate override will be counted per Invoice or individual Item on the invoice.

  - `brmObjects.TrialDuration` (string)
    Trial Duration: Indicates how the Trial duration is calculated. Available options are: Limited Use: The Trial will be a used a number of times specified in the product setup. Duration: (Default Option) The Trial will be applicable for the duration specified on the product configuration.

  - `brmObjects.TrialMaxNumberUses` (string)
    Max Number of Uses: Indicates the number of times Trail can apply

  - `brmObjects.ItemizeTrialDiscounts` (string)
    ItemizeTrialDiscounts

  - `brmObjects.TrialRateType` (string)
    Rate Type: Indicates how the Trial rate is calculated and applied. Available options are: Percentage Off: The Trial will be a percentage of the target product's cost.Fixed Amount: (Default Option) The Trial will be a fixed rate regardless of the cost of the product that the discount is applied to. Override Rate: The Trial rate will override the rate on the target products while the trial is in effect. Formula: The trail cost override  generated by formula will apply to target products

  - `brmObjects.ZeroRateBanded` (integer)
    Zero Rate Banded Products: When checked the products listed in the Band Products section ignore their defined rate and always generate zero rated activity; the charges for those product will be determined in accordance to the rates defined in this product. When unchecked the Band Products generate charges in accordance to their defined rates as well as the rates defined in this product

  - `brmObjects.ProductId` (integer)
    ProductId: Billing component id

  - `brmObjects.AccountProductId` (integer, required)
    AccountProductId

  - `brmObjects.OnEndDate` (string)
    OnEndDate

  - `brmObjects.RenewalOrChangeTerm` (string)
    RenewalOrChangeTerm

  - `brmObjects.ChangeToProductByDefault` (integer)
    ChangeToProductByDefault

  - `brmObjects.MinMaxGenerateOnNegative` (integer)
    Generate True-Up when Cost is <= 0: Check this box to generate a True-up charge when the cost is less than or equal to zero. Not checking this box will ignore the minimum charge pricing. This can be useful for things like negative charges that are the result of a credit or adjustment.

  - `brmObjects.MinMaxZeroQuantityTrueUp` (integer)
    Generate 0-quantity activity on True-up charge: Checking this box will override the default quantity of    1    when generating the true-up charge (activity) for a minimum or maximum charge. Generating a zero quantity is useful when leveraging effective rating because it doesn   t add an additional quantity of 1 when calculating an average rate across the individual product charges on a given invoice.

  - `brmObjects.FormulaFlag` (integer)
    Formula Based Quantity/Cost

  - `brmObjects.UseHistoricalInvoiceForPrepayment` (integer)
    Use Historical Invoice For Prepayment: When selected, creates charges on historical invoices in Current status.

  - `brmObjects.ForceGenerateActivity` (integer)
    Force Generate Activity: Check this flag to force the creation of a charge on invoice closure even if the Formula Group Record Filter rules are not satisfied. This can be used for evaluating NULL values on aggregated data. For example: NVL(SUM({!ActivityObj.Cost}), 0).

  - `brmObjects.SplitBySubAccount` (integer)
    Spit Charges By Sub Account: Check this flag is you would like the charge to be created individually under every element of account hierarchy. In case of parent/child account hierarchy the charge will be created under each child record.

  - `brmObjects.CMTQuantity` (string)
    Minimum Committed Quantity: Minimum committed quantity is the smallest quantity a customer must reach to avoid application unmet commitment recuperation charge by the system. In case of unmet commitment condition the system users tiering table below to convert the quantity shortfall into currency equivalent recuperation charge.

  - `brmObjects.AccumFlag` (string)
    Tier Aggregation Time Interval: Unless overridden the tier aggregation starts at the beginning of the invoicing cycle and finishes at the end of it, starting the next invoicing cycle at 0. Check this box to override the aggregation interval

  - `brmObjects.AccumResetPeriod` (string)
    Custom Tier Aggregation Interval Length: The time interval for aggregating usage has a predetermined duration. Upon reaching the end of the term the count is reset to 0 and aggregation starts again. Set the custom tier aggregation interval to the number of months the system should aggregate the use for.

  - `brmObjects.AccumStartDate` (string)
    Tier Aggregation Start Date: The start date when tier aggregation will commence. If left unchanged the system uses contract start date.

  - `brmObjects.CMTInclusionLogic` (string)
    Filtered Criteria Join Logic: Use this to define the logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. So let`s say you have three filters, use this field to define a meaning across the three references.For example: (1 AND 2 ) OR 3 Use parentheses as well as AND and OR operators to define the filter logic

  - `brmObjects.CMTTaxFlag` (integer)
    Tax Inclusive: When checked the revenue commitment targets assessed against tax inclusive charges, leave unchecked for tax exclusive

  - `brmObjects.CMTScope` (string)
    Commitment Scope: Revenue from multiple accounts can count towards a single revenue commitment target. Owning Account:  option accumulates revenue from contributing products of an account to which revenue commitment product has been provisioned.Account Hierarchy:  option accumulates revenue from contributing products of owning account plus all descendent accountsCustomer Affiliation:  option presents a filter to define grouping of accounts for the purpose of revenue accumulation

  - `brmObjects.CMTTermDuration` (string)
    Commitment Term Duration: Defines the time horizon for meeting revenue commitment targets.

  - `brmObjects.CMTRateMethod` (string)
    Commitment Target Terms: Revenue commitment target can be defined in terms of monetary amounts or quantity amount. Cost Defined: commitments measure customer obligations in cost terms.Quantity Defined: commitments measure customer obligations in quantity terms. The unmet quantity is passed to the recuperating product to determine the actual charge amount

  - `brmObjects.TrueUpMethod` (string)
    True up Method: Under bulk tiering qualifying for a new tier mandates issuing a retroactive adjustment to usage from the same accumulation period issued on prior invoices. Two system supported ways exist to true-up the balance. To issue a credit adjustment for the difference select Credit Adjustment or choose Credit Product to issue a one time charge

  - `brmObjects.TrueUpProduct` (integer)
    Product: True Up one-charge Product

  - `brmObjects.EligibleActivityFilterLogic` (string)
    Eligible Activity Filter Logic: Use this to define logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. In case you have 3 filters you can use this field to define more meaning accross the three. For example: (1 AND 2) OR 3. Use parentheses as well as AND and OR operator to define the filter logic.

  - `brmObjects.UseFlatRate` (string)
    Use Flat Rate

  - `brmObjects.GenerateFlatFee` (integer)
    Generate Flat Fee

  - `brmObjects.ExternalKey` (string)
    ExternalKey

  - `brmObjects.DesignateDiscountTargetChargesBy` (string)
    Designate Target Charges By: Identifies the system charges affected by the discount. Do one of the following: Specify the product. Set up the filter that a billing activity must match to be included.

  - `brmObjects.DiscountTargetFilterLogic` (string)
    Filtered Products Join Logic

  - `brmObjects.DesignateDiscountEligableChargesBy` (string)
    Designate Eligable Charges By

  - `brmObjects.DiscountEligableFilterLogic` (string)
    Filtered Products Join Logic

  - `brmObjects.TaxRateDate` (string)
    Tax Rate Date: By default activity creation date is used to lookup rate, if you need to modify behavior to for example subscription start date configure this with a formula in this field

  - `brmObjects.ChargeInAdvancePeriod` (string)
    Charge In Advance Period

  - `brmObjects.ChargeInAdvanceUnit` (string, required)
    Charge In Advance Period Unit

  - `brmObjects.IncludedUsageAmountsId` (string)
    Included Usage Amounts Id

  - `brmObjects.NonBillableFlag` (integer)
    Non-Billable: Non-Billable Account Products do not generate charges. Setting the Non-Billable flag on the Account Product results in no charges generated by the Account Product. This is primarily used to handle certain Rev Rec Cases where Billing is not needed

  - `brmObjects.AutoCalculateCredit` (integer)
    Enable Auto-Credit: Enabled by default. Leave checked unless the product is not in a linear relationship with other products. See the Help topic about Auto-Credit for more information.

  - `brmObjects.EffectiveDate` (string)
    Effective Date

  - `brmObjects.EndDate` (string)
    End Date

  - `brmObjects.SubscriptionDiscountDate` (string)
    Subscription Discount Rating Date: This provides an option for itemized discount charges to inherit the from/to dates of the subscription charges it discounts. It further enables alignment of the discount activity date with the charge it discounts.

  - `brmObjects.RecalculateOnRateChange` (integer)
    Recalculate on Rate Change: If rate for subscription is changed within the period that subscription charge covers, enabling this checkbox will allow splitting of subscription charges with corresponding prorated rates.

  - `brmObjects.AggregationLevel` (string)
    Tier Calculation Level: Indicate the aggregate level of the tiered rates. Available options are: Package: Calculates aggregation within the package only and if multiple packages, instances of the product within each contribute to will be considered. Product:  Calculates aggregation at the usage that belongs to the same product instance. Account:  Calculates aggregation at individual levels of hierarchy if account is part of hierarchy. Invoice:  (Default Option) Calculates aggregation for all instances of the product on the invoice. Custom:  This allows for the definition of custom aggregation rules. This opens the Tier Calculation Grouping that will allow entry of aggregation points using the object reference model. Contract:  Calculates aggregation at the usage that belongs to the same contract rate. Select this option if you want any usage rated using the parent's contract to be stacked and rated together with other usage regardless of the account it came from.

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.DiscountPricingType` (string)
    Discount Type: Discount Type - Select desired discount type:  Standard: Discounts invoice either on a fixed amount or percentage basis Conditional: Define conditions that once met result in application of the discount Voucher:  Grants a fixed monetary amount to be utilized during fixed amount of time (validity period)

  - `brmObjects.DependentType` (string)
    Type: Indicate how the charge will be applied. Available options are:	Amount: Fixed amount will be applied.	Percentage: (Default Option) Percentage of the charged amount will be applied.

  - `brmObjects.AllowInternationalPricing` (integer)
    AllowInternationalPricing

  - `brmObjects.DiscountType` (string)
    Rate Type: Select how to calculate and apply the Trial rate. Percentage Off: The Trial rate is a percentage of the product cost. Fixed Amount: (Default) The Trial is a fixed amount regardless of the product's price. Override Rate: The Trial rate overrides the rate on the target product(s) while the Trial is in effect. Formula: The Trial cost is generated by a formula and applied to target product(s).

  - `brmObjects.FormulaFilterLogic` (string)
    Formula Group FIlter Logic

  - `brmObjects.FormulaQuantity` (string)
    Formula Quantity:  Indicates the quantity that will be used during rating. If left blank, this is defaulted to 1. If a formula is provided, it will obtain the value by evaluating the formula. The platform formula language can be used here.

  - `brmObjects.CMTInputMethod` (string)
    Contributing Charges Input Method: Designates products or packages included into revenue commitment target. Filter: Input option the products or packages are identified by their propertiesLookup List: option they are chosen individually from the list

  - `brmObjects.TrueUpCreditType` (string)
    Credit Type: Credit Type for credit adjustment

  - `brmObjects.ProrateBand` (integer)
    Prorate Band: Determines if the band is prorated depending on the start/end date of the provisioned account product that contains the billing identifier. When ticked and the start or end date falls in the middle of an invoice cycle, the band is prorated.

  - `brmObjects.ChargeInSubsequentPer` (string)
    Charge in Subsequent Period

  - `brmObjects.ChargeInSubsequentUnit` (string)
    Charge in Subsequent Period Unit

  - `brmObjects.SSPProfileId` (integer)
    SSP Profile

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.QuoteProductDraftId` (integer)
    QuoteProductDraftId

  - `retrieveResponse.QuoteProductId` (integer)
    QuoteProductId

  - `retrieveResponse.CalculateEffectiveRate` (integer)
    Calculate Effective Rate

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.RatingMethodType` (string)
    Rating Method: Specifies the rating method applied to the product. See the Rating Methods Overview topic for more information.

  - `retrieveResponse.Id` (string)
    Id

  - `retrieveResponse.PricingType` (string)
    Pricing Type: Indicates the type of pricing that the product will use. Available options are:	Standard Pricing: Specify the rate in currencies configured on the platform. This is the basic per usage unit charge.	Tiered Pricing: Specify tiered rates. This enables the flexibility of indicating different rates based on the number of usage units.

  - `retrieveResponse.ProrateSubscription` (string)
    Prorate Subscription Charges: Indicates whether the charge for the subscription is for the whole amount or pro-rated if it is activated in the middle of the customer's billing cycle.

  - `retrieveResponse.SubscriptionModel` (string)
    Payment Model: Indicates when the subscription charges are reflected on the customer's invoice. Available options are:	Postpaid: (Default Option) Results in the subscription charge being displayed on the customer's invoice after the subscription dates have taken place.	Prepaid: Results in the charge appearing on customer's invoices before the subscription dates have taken place.

  - `retrieveResponse.AggregateRateType` (string)
    Tiered Rate Type: Allows for choosing the behavior of how usage data is handled for tier rates. Available choices are:	Bulk: Applies the rate of the final tier to all the usage units.	Incremental: Applies the rate for usage allocated to each tier respectively.	Block: Applies the rate for usage using the number of iterations and block size specified for each tier. The usage is divided by the block size and the result is multiplied by the rate. The number of iterations becomes the threshold for the tier.

  - `retrieveResponse.IntervalSubscriptionDays` (string)
    Interval (Days): Enter the number of days that must lapse until the customer is billed again.

  - `retrieveResponse.IncrementAmount` (string)
    IncrementAmount

  - `retrieveResponse.ExcludeComponents` (string)
    ExcludeComponents

  - `retrieveResponse.SplitUsage` (integer)
    Split Usage Crossing Bands: When dealing with large chunks of data, enabling this option will allow the splitting of usage data across bands. Disabling the option will have the large chunk rated against the lower band.

  - `retrieveResponse.PropagateInvLevelCharge` (integer)
    Propagate Charges to Hierarchy: When this flag is checked the product charge will be applied to all accounts in the system regardless if the product is included as part of the account product or account package product.

  - `retrieveResponse.CycleType` (string)
    Cycle Context: Indicates when the charge is applied relative to the customer's billing cycle: Sync with Service Start Date: Charge is applied on the day the product or service is provisioned. Sync with Billing Cycle: (Default) Charge is applied at the start of the billing cycle.

  - `retrieveResponse.ActivationChargePlace` (string)
    Initial Invoice Creation: Indicates when the invoice will be created to cover the new subscription. Available options are:	Create Activation Invoice for New Customers: (Default Option) Invoice is immediately created for a customer when the subscription being added is the first one for the said customer.	Always Create Activation Invoice: Invoice is immediately created for a customer regardless if it is the first subscription or not.	Use Billing Cycle Invoice: Invoice is not generated immediately and all subscription charges are included in the standard invoice of the customer (e.g. included in the next billing cycle).

  - `retrieveResponse.LateFeeType` (string)
    Late Fee Type: Indicates the manner of adding the late fee to the invoice that is being closed. Available options are:			Percentage: (Default Option) The percentage of the past due balance will be taken and added to the overall amount. The behavior is further influenced by the Late Fee Against Balance field.		Fixed Fee: A flat fee will be added to the invoice regardless of the amount and age of the unpaid balance.

  - `retrieveResponse.LateFeeAgainstBalance` (string)
    Late Fee Against Balance: Late Fee Against Balance	Indicates the multiplier/factor that will be used to compute with the late fee percentage. Available options are:			Last Bill Cycle: (Default Option) The last balance due from the last billing cycle will be taken when computing for the percentage.		Total Late Balance: The total unpaid balance due from all previous billing cycles will be taken when computing for the percentage.		Annual Percentage Rate: The number of late days will be used as the factor for getting the percentage.

  - `retrieveResponse.SubAggrLevel` (string)
    Shared Across: Indicates which overage information will be monitored and rated. Available options are:			Account: (Default Option) Usage routed to any product in the account will be rated if defined in the Overage Component table.		Package: Usage routed to any product in the package where the subscription exists will be rated if defined in the Overage Component table		Invoice: Any usage in the invoice that is specified in the Overage Component table under any subscription on that invoice will be rated.		Custom Affiliation: option presents a filter to identify billing activities consuming included quantities.

  - `retrieveResponse.DiscountApplMethod` (string)
    Application Method

  - `retrieveResponse.DiscountEligUnitMeas` (string)
    Units of Measure for Eligible Charges

  - `retrieveResponse.FormulaParamIdent` (string)
    Formula Parameter Identifier

  - `retrieveResponse.TaxApplication` (string)
    Tax Application: Indicates where the amount will be taken from and will be used for tax computation. Available options are:			Per Invoice: (Default Option) Amount to be computed for tax will be taken from the total invoice amount.		Per Product: Amount to be computed for tax will be taken from the products in the invoice.

  - `retrieveResponse.ChargeType` (string)
    Charge Type: Choose how to apply the Fee or Surcharge: Per Invoice: (Default) Adds a fixed amount to the invoice regardless of the total amount. Percentage: Calculates the fee or surcharge as a percentage of the invoice total.

  - `retrieveResponse.FormulaValue` (string)
    Formula Cost: Refer to the Formula Value Calculation help topic for more information.

  - `retrieveResponse.ApplyChargeOnComponent` (integer)
    Apply Charge on Component: Indicate the product/component that will trigger the application of the charge.

  - `retrieveResponse.DiscountPriority` (string)
    Discount Priority

  - `retrieveResponse.DiscountApplyTo` (string)
    Apply To

  - `retrieveResponse.NumberOfCharges` (string)
    NumberOfCharges

  - `retrieveResponse.DiscountEligCond` (string)
    DiscountEligCond

  - `retrieveResponse.DefaultRateFlag` (integer)
    DefaultRateFlag

  - `retrieveResponse.DiscountItemize` (integer)
    Itemize Discount: Specifies if the discount is applied to all products that are eligible for the discount on the invoice or not.			Checked: Discount will be applied to all occurrences of the eligible product that appears on the invoice.		Unchecked: (Default Option) The discount will apply on the invoice once.

  - `retrieveResponse.SubscriptionCycle` (string)
    Subscription Cycle: Indicates the renewal/charging cycle of the subscription

  - `retrieveResponse.EarlyTerminationOption` (string)
    Early Termination Option: Specifies the behavior of a subscription when it ends early. Prorate Current Invoice: (Default) If the related invoice is not closed, the last subscription charge is prorated. If the related invoice is closed, a credit note for the subscription charges is not created. Credit: If the related invoice is not closed, the last subscription charge is prorated. If the related invoice is closed, a credit note for the subscription charges is created.

  - `retrieveResponse.ProrateCreditAfterPeriod` (string)
    Prorate Credit After Period (Days)

  - `retrieveResponse.TaxType` (string)
    Tax Type: Indicates the manner of adding the tax product will be applied. The amount on which the tax will be applied will also be influenced by the Tax Application field. Available options are:			Percentage: (Default Option) The percentage of the amount will be taken.		Fixed or Flat Fee: A flat fee will be added to the invoice regardless of the amount.

  - `retrieveResponse.OverrideTypePackage` (integer)
    OverrideTypePackage

  - `retrieveResponse.DiscountLimitedUsage` (integer)
    Limited Usage: Indicates if the discount can be used a limited number of times instead of perpetual.			Checked: Discount can be used a limited number of times.		Unchecked: (Default Option) Discount can be used perpetually whenever there are eligible charges.

  - `retrieveResponse.DiscountMaxNumberOfUses` (string)
    Max Number of Uses: Enter the maximum number of times Trial can be applied.

  - `retrieveResponse.DiscountUsePer` (string)
    Use Per: Only applicable when Limited Usage is checked.			Invoice: (Default Option) The limited use counter is decremented once per invoice.		Item: The limited use counter is decremented for each instance of an eligible product on the invoice.

  - `retrieveResponse.FlatRate` (integer)
    Use Tier Price as Flat Rate: Setting Flat Rate flag will price the activity at a flat rate of a tier, without multiplying the rate by the cost. In case of the Incremental pricing the cost of each tier < quantity of rated activity will be added up for final cost. In case of the Bulk pricing only one flat rate will be used based on the corresponding tier for quantity on activity.

  - `retrieveResponse.formulaOnInvoiceClose` (integer)
    On Invoice Close: Setting on Invoice Close flag will trigger the system to evaluate the records (or groups of records if Group Identifier is specified) and create a record for every formula evaluation meeting the condition.

  - `retrieveResponse.commitmentApplicableProduct` (string)
    commitmentApplicableProduct: Applicable Product for Minimum Commitment

  - `retrieveResponse.TaxApplicableTo` (string)
    Applicable To: Select if the tax should apply to all the products or just a subset based on the filter criteria

  - `retrieveResponse.TaxProductFilterLogic` (string)
    Filtered Products Join Logic: Use this to define logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. In case you have 3 filters you can use this field to define more meaning accross the three. For example: (1 AND 2) OR 3. Use parentheses as well as AND and OR operator to define the filter logic.

  - `retrieveResponse.ForbidChargeInPreviousPeriod` (integer)
    ForbidChargeInPreviousPeriod

  - `retrieveResponse.AutoRefill` (integer)
    Auto Refill: Indicates if a new prepaid usage product charge is generated and invoiced to the customer when the linked usage quantity is used up. If left unchecked, the prepaid usage product will not generate a new charge and the linked usage product will be invoiced using the active rate. When checked, a new prepaid product charge is generated and the included 'free' usage is added to the linked overage product

  - `retrieveResponse.ZeroRatedDisplayFlag` (string)
    Display Zero-rated Components on Invoice

  - `retrieveResponse.ObligatoryIntlRate` (integer)
    Raise Alert on Missing International Rate: Select to enable a system alert when the international rate is missing. If deselected, the system substitutes the product's default rate for the missing international rate.

  - `retrieveResponse.TrialTarget` (string)
    Products Eligible for Trial: Indicates which products are eligible for Trial and to which products rate reduction will be applied.

  - `retrieveResponse.TrialUsePer` (string)
    Use Per: Indicates if the  Max Number of Uses from application Trial discount or rate override will be counted per Invoice or individual Item on the invoice.

  - `retrieveResponse.TrialDuration` (string)
    Trial Duration: Indicates how the Trial duration is calculated. Available options are: Limited Use: The Trial will be a used a number of times specified in the product setup. Duration: (Default Option) The Trial will be applicable for the duration specified on the product configuration.

  - `retrieveResponse.TrialMaxNumberUses` (string)
    Max Number of Uses: Indicates the number of times Trail can apply

  - `retrieveResponse.ItemizeTrialDiscounts` (string)
    ItemizeTrialDiscounts

  - `retrieveResponse.TrialRateType` (string)
    Rate Type: Indicates how the Trial rate is calculated and applied. Available options are: Percentage Off: The Trial will be a percentage of the target product's cost.Fixed Amount: (Default Option) The Trial will be a fixed rate regardless of the cost of the product that the discount is applied to. Override Rate: The Trial rate will override the rate on the target products while the trial is in effect. Formula: The trail cost override  generated by formula will apply to target products

  - `retrieveResponse.ZeroRateBanded` (integer)
    Zero Rate Banded Products: When checked the products listed in the Band Products section ignore their defined rate and always generate zero rated activity; the charges for those product will be determined in accordance to the rates defined in this product. When unchecked the Band Products generate charges in accordance to their defined rates as well as the rates defined in this product

  - `retrieveResponse.ProductId` (integer)
    ProductId: Billing component id

  - `retrieveResponse.AccountProductId` (integer)
    AccountProductId

  - `retrieveResponse.OnEndDate` (string)
    OnEndDate

  - `retrieveResponse.RenewalOrChangeTerm` (string)
    RenewalOrChangeTerm

  - `retrieveResponse.ChangeToProductByDefault` (integer)
    ChangeToProductByDefault

  - `retrieveResponse.MinMaxGenerateOnNegative` (integer)
    Generate True-Up when Cost is <= 0: Check this box to generate a True-up charge when the cost is less than or equal to zero. Not checking this box will ignore the minimum charge pricing. This can be useful for things like negative charges that are the result of a credit or adjustment.

  - `retrieveResponse.MinMaxZeroQuantityTrueUp` (integer)
    Generate 0-quantity activity on True-up charge: Checking this box will override the default quantity of    1    when generating the true-up charge (activity) for a minimum or maximum charge. Generating a zero quantity is useful when leveraging effective rating because it doesn   t add an additional quantity of 1 when calculating an average rate across the individual product charges on a given invoice.

  - `retrieveResponse.FormulaFlag` (integer)
    Formula Based Quantity/Cost

  - `retrieveResponse.UseHistoricalInvoiceForPrepayment` (integer)
    Use Historical Invoice For Prepayment: When selected, creates charges on historical invoices in Current status.

  - `retrieveResponse.ForceGenerateActivity` (integer)
    Force Generate Activity: Check this flag to force the creation of a charge on invoice closure even if the Formula Group Record Filter rules are not satisfied. This can be used for evaluating NULL values on aggregated data. For example: NVL(SUM({!ActivityObj.Cost}), 0).

  - `retrieveResponse.SplitBySubAccount` (integer)
    Spit Charges By Sub Account: Check this flag is you would like the charge to be created individually under every element of account hierarchy. In case of parent/child account hierarchy the charge will be created under each child record.

  - `retrieveResponse.CMTQuantity` (string)
    Minimum Committed Quantity: Minimum committed quantity is the smallest quantity a customer must reach to avoid application unmet commitment recuperation charge by the system. In case of unmet commitment condition the system users tiering table below to convert the quantity shortfall into currency equivalent recuperation charge.

  - `retrieveResponse.AccumFlag` (string)
    Tier Aggregation Time Interval: Unless overridden the tier aggregation starts at the beginning of the invoicing cycle and finishes at the end of it, starting the next invoicing cycle at 0. Check this box to override the aggregation interval

  - `retrieveResponse.AccumResetPeriod` (string)
    Custom Tier Aggregation Interval Length: The time interval for aggregating usage has a predetermined duration. Upon reaching the end of the term the count is reset to 0 and aggregation starts again. Set the custom tier aggregation interval to the number of months the system should aggregate the use for.

  - `retrieveResponse.AccumStartDate` (string)
    Tier Aggregation Start Date: The start date when tier aggregation will commence. If left unchanged the system uses contract start date.

  - `retrieveResponse.CMTInclusionLogic` (string)
    Filtered Criteria Join Logic: Use this to define the logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. So let`s say you have three filters, use this field to define a meaning across the three references.For example: (1 AND 2 ) OR 3 Use parentheses as well as AND and OR operators to define the filter logic

  - `retrieveResponse.CMTTaxFlag` (integer)
    Tax Inclusive: When checked the revenue commitment targets assessed against tax inclusive charges, leave unchecked for tax exclusive

  - `retrieveResponse.CMTScope` (string)
    Commitment Scope: Revenue from multiple accounts can count towards a single revenue commitment target. Owning Account:  option accumulates revenue from contributing products of an account to which revenue commitment product has been provisioned.Account Hierarchy:  option accumulates revenue from contributing products of owning account plus all descendent accountsCustomer Affiliation:  option presents a filter to define grouping of accounts for the purpose of revenue accumulation

  - `retrieveResponse.CMTTermDuration` (string)
    Commitment Term Duration: Defines the time horizon for meeting revenue commitment targets.

  - `retrieveResponse.CMTRateMethod` (string)
    Commitment Target Terms: Revenue commitment target can be defined in terms of monetary amounts or quantity amount. Cost Defined: commitments measure customer obligations in cost terms.Quantity Defined: commitments measure customer obligations in quantity terms. The unmet quantity is passed to the recuperating product to determine the actual charge amount

  - `retrieveResponse.TrueUpMethod` (string)
    True up Method: Under bulk tiering qualifying for a new tier mandates issuing a retroactive adjustment to usage from the same accumulation period issued on prior invoices. Two system supported ways exist to true-up the balance. To issue a credit adjustment for the difference select Credit Adjustment or choose Credit Product to issue a one time charge

  - `retrieveResponse.TrueUpProduct` (integer)
    Product: True Up one-charge Product

  - `retrieveResponse.EligibleActivityFilterLogic` (string)
    Eligible Activity Filter Logic: Use this to define logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. In case you have 3 filters you can use this field to define more meaning accross the three. For example: (1 AND 2) OR 3. Use parentheses as well as AND and OR operator to define the filter logic.

  - `retrieveResponse.UseFlatRate` (string)
    Use Flat Rate

  - `retrieveResponse.GenerateFlatFee` (integer)
    Generate Flat Fee

  - `retrieveResponse.ExternalKey` (string)
    ExternalKey

  - `retrieveResponse.DesignateDiscountTargetChargesBy` (string)
    Designate Target Charges By: Identifies the system charges affected by the discount. Do one of the following: Specify the product. Set up the filter that a billing activity must match to be included.

  - `retrieveResponse.DiscountTargetFilterLogic` (string)
    Filtered Products Join Logic

  - `retrieveResponse.DesignateDiscountEligableChargesBy` (string)
    Designate Eligable Charges By

  - `retrieveResponse.DiscountEligableFilterLogic` (string)
    Filtered Products Join Logic

  - `retrieveResponse.TaxRateDate` (string)
    Tax Rate Date: By default activity creation date is used to lookup rate, if you need to modify behavior to for example subscription start date configure this with a formula in this field

  - `retrieveResponse.ChargeInAdvancePeriod` (string)
    Charge In Advance Period

  - `retrieveResponse.ChargeInAdvanceUnit` (string)
    Charge In Advance Period Unit

  - `retrieveResponse.IncludedUsageAmountsId` (string)
    Included Usage Amounts Id

  - `retrieveResponse.NonBillableFlag` (integer)
    Non-Billable: Non-Billable Account Products do not generate charges. Setting the Non-Billable flag on the Account Product results in no charges generated by the Account Product. This is primarily used to handle certain Rev Rec Cases where Billing is not needed

  - `retrieveResponse.AutoCalculateCredit` (integer)
    Enable Auto-Credit: Enabled by default. Leave checked unless the product is not in a linear relationship with other products. See the Help topic about Auto-Credit for more information.

  - `retrieveResponse.EffectiveDate` (string)
    Effective Date

  - `retrieveResponse.EndDate` (string)
    End Date

  - `retrieveResponse.SubscriptionDiscountDate` (string)
    Subscription Discount Rating Date: This provides an option for itemized discount charges to inherit the from/to dates of the subscription charges it discounts. It further enables alignment of the discount activity date with the charge it discounts.

  - `retrieveResponse.RecalculateOnRateChange` (integer)
    Recalculate on Rate Change: If rate for subscription is changed within the period that subscription charge covers, enabling this checkbox will allow splitting of subscription charges with corresponding prorated rates.

  - `retrieveResponse.AggregationLevel` (string)
    Tier Calculation Level: Indicate the aggregate level of the tiered rates. Available options are: Package: Calculates aggregation within the package only and if multiple packages, instances of the product within each contribute to will be considered. Product:  Calculates aggregation at the usage that belongs to the same product instance. Account:  Calculates aggregation at individual levels of hierarchy if account is part of hierarchy. Invoice:  (Default Option) Calculates aggregation for all instances of the product on the invoice. Custom:  This allows for the definition of custom aggregation rules. This opens the Tier Calculation Grouping that will allow entry of aggregation points using the object reference model. Contract:  Calculates aggregation at the usage that belongs to the same contract rate. Select this option if you want any usage rated using the parent's contract to be stacked and rated together with other usage regardless of the account it came from.

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.DiscountPricingType` (string)
    Discount Type: Discount Type - Select desired discount type:  Standard: Discounts invoice either on a fixed amount or percentage basis Conditional: Define conditions that once met result in application of the discount Voucher:  Grants a fixed monetary amount to be utilized during fixed amount of time (validity period)

  - `retrieveResponse.DependentType` (string)
    Type: Indicate how the charge will be applied. Available options are:	Amount: Fixed amount will be applied.	Percentage: (Default Option) Percentage of the charged amount will be applied.

  - `retrieveResponse.AllowInternationalPricing` (integer)
    AllowInternationalPricing

  - `retrieveResponse.DiscountType` (string)
    Rate Type: Select how to calculate and apply the Trial rate. Percentage Off: The Trial rate is a percentage of the product cost. Fixed Amount: (Default) The Trial is a fixed amount regardless of the product's price. Override Rate: The Trial rate overrides the rate on the target product(s) while the Trial is in effect. Formula: The Trial cost is generated by a formula and applied to target product(s).

  - `retrieveResponse.FormulaFilterLogic` (string)
    Formula Group FIlter Logic

  - `retrieveResponse.FormulaQuantity` (string)
    Formula Quantity:  Indicates the quantity that will be used during rating. If left blank, this is defaulted to 1. If a formula is provided, it will obtain the value by evaluating the formula. The platform formula language can be used here.

  - `retrieveResponse.CMTInputMethod` (string)
    Contributing Charges Input Method: Designates products or packages included into revenue commitment target. Filter: Input option the products or packages are identified by their propertiesLookup List: option they are chosen individually from the list

  - `retrieveResponse.TrueUpCreditType` (string)
    Credit Type: Credit Type for credit adjustment

  - `retrieveResponse.ProrateBand` (integer)
    Prorate Band: Determines if the band is prorated depending on the start/end date of the provisioned account product that contains the billing identifier. When ticked and the start or end date falls in the middle of an invoice cycle, the band is prorated.

  - `retrieveResponse.ChargeInSubsequentPer` (string)
    Charge in Subsequent Period

  - `retrieveResponse.ChargeInSubsequentUnit` (string)
    Charge in Subsequent Period Unit

  - `retrieveResponse.SSPProfileId` (integer)
    SSP Profile

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error