Billing Platform API
Billing Platform API
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/RATING_METHOD/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "TaxApplicableTo": "string", "AutoRefill": 0, "FormulaValue": "string", "SubscriptionCycle": "string", "TaxApplication": "string", "ChargeType": "string", "CMTTaxFlag": 0, "EligibleActivityFilterLogic": "string", "DesignateDiscountEligableChargesBy": "string", "TrialUsePer": "string", "TrialTarget": "string", "ZeroRatedDisplayFlag": "string", "TaxProductFilterLogic": "string", "ProrateSubscription": "string", "DiscountEligUnitMeas": "string", "FormulaParamIdent": "string", "TrialDuration": "string", "ProrateBand": 0, "FormulaFlag": 0, "UseHistoricalInvoiceForPrepayment": 0, "CMTInclusionLogic": "string", "CMTRateMethod": "string", "UseFlatRate": "string", "ChargeInAdvanceUnit": "string", "MinMaxZeroQuantityTrueUp": 0, "TaxRateDate": "string", "DiscountUsePer": "string", "SubscriptionModel": "string", "ActivationChargePlace": "string", "DiscountItemize": 0, "ProrateCreditAfterPeriod": "string", "CMTTermDuration": "string", "DiscountEligableFilterLogic": "string", "TrialMaxNumberUses": "string", "ApplyChargeOnComponent": 0, "TrialRateType": "string", "FlatRate": 0, "DiscountLimitedUsage": 0, "DiscountMaxNumberOfUses": "string", "CMTScope": "string", "AccumResetPeriod": "string", "RecalculateOnRateChange": 0, "GenerateFlatFee": 0, "DiscountTargetFilterLogic": "string", "TrueUpCreditType": "string", "ChargeInSubsequentPer": "string", "ObligatoryIntlRate": 0, "FormulaQuantity": "string", "PricingType": "string", "SplitUsage": 0, "DependentType": "string", "ForceGenerateActivity": 0, "DesignateDiscountTargetChargesBy": "string", "CalculateEffectiveRate": 0, "NonBillableFlag": 0, "ChargeInSubsequentUnit": "string", "LateFeeType": "string", "SubAggrLevel": "string", "DiscountType": "string", "DiscountApplMethod": "string", "DiscountPricingType": "string", "TrueUpMethod": "string", "ChargeInAdvancePeriod": "string", "MinMaxGenerateOnNegative": 0, "DiscountApplyTo": "string", "AggregationLevel": "string", "IntervalSubscriptionDays": "string", "CycleType": "string", "TaxType": "string", "formulaOnInvoiceClose": 0, "FormulaFilterLogic": "string", "SplitBySubAccount": 0, "CMTInputMethod": "string", "CMTQuantity": "string", "TrueUpProduct": 0, "RatingMethodType": "string", "AggregateRateType": "string", "PropagateInvLevelCharge": 0, "LateFeeAgainstBalance": "string", "DiscountPriority": "string", "EarlyTerminationOption": "string", "ZeroRateBanded": 0, "AccumFlag": "string", "AccumStartDate": "string", "AutoCalculateCredit": 0, "SSPProfileId": 0, "IncludedUsageAmountsId": "string", "QuoteProductDraftId": 0, "QuoteProductId": 0, "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "IncrementAmount": "string", "ExcludeComponents": "string", "NumberOfCharges": "string", "DiscountEligCond": "string", "DefaultRateFlag": 0, "OverrideTypePackage": 0, "commitmentApplicableProduct": "string", "ForbidChargeInPreviousPeriod": 0, "ItemizeTrialDiscounts": "string", "ProductId": 0, "AccountProductId": 0, "OnEndDate": "string", "RenewalOrChangeTerm": "string", "ChangeToProductByDefault": 0, "Created": "string", "AllowInternationalPricing": 0, "ExternalKey": "string" } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/RATING_METHOD?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "TaxApplicableTo": "string", "AutoRefill": 0, "FormulaValue": "string", "SubscriptionCycle": "string", "TaxApplication": "string", "ChargeType": "string", "CMTTaxFlag": 0, "EligibleActivityFilterLogic": "string", "DesignateDiscountEligableChargesBy": "string", "TrialUsePer": "string", "TrialTarget": "string", "ZeroRatedDisplayFlag": "string", "TaxProductFilterLogic": "string", "ProrateSubscription": "string", "DiscountEligUnitMeas": "string", "FormulaParamIdent": "string", "TrialDuration": "string", "ProrateBand": 0, "FormulaFlag": 0, "UseHistoricalInvoiceForPrepayment": 0, "CMTInclusionLogic": "string", "CMTRateMethod": "string", "UseFlatRate": "string", "ChargeInAdvanceUnit": "string", "MinMaxZeroQuantityTrueUp": 0, "TaxRateDate": "string", "DiscountUsePer": "string", "SubscriptionModel": "string", "ActivationChargePlace": "string", "DiscountItemize": 0, "ProrateCreditAfterPeriod": "string", "CMTTermDuration": "string", "DiscountEligableFilterLogic": "string", "TrialMaxNumberUses": "string", "ApplyChargeOnComponent": 0, "TrialRateType": "string", "FlatRate": 0, "DiscountLimitedUsage": 0, "DiscountMaxNumberOfUses": "string", "CMTScope": "string", "AccumResetPeriod": "string", "RecalculateOnRateChange": 0, "GenerateFlatFee": 0, "DiscountTargetFilterLogic": "string", "TrueUpCreditType": "string", "ChargeInSubsequentPer": "string", "ObligatoryIntlRate": 0, "FormulaQuantity": "string", "PricingType": "string", "SplitUsage": 0, "DependentType": "string", "ForceGenerateActivity": 0, "DesignateDiscountTargetChargesBy": "string", "CalculateEffectiveRate": 0, "NonBillableFlag": 0, "ChargeInSubsequentUnit": "string", "LateFeeType": "string", "SubAggrLevel": "string", "DiscountType": "string", "DiscountApplMethod": "string", "DiscountPricingType": "string", "TrueUpMethod": "string", "ChargeInAdvancePeriod": "string", "MinMaxGenerateOnNegative": 0, "DiscountApplyTo": "string", "AggregationLevel": "string", "IntervalSubscriptionDays": "string", "CycleType": "string", "TaxType": "string", "formulaOnInvoiceClose": 0, "FormulaFilterLogic": "string", "SplitBySubAccount": 0, "CMTInputMethod": "string", "CMTQuantity": "string", "TrueUpProduct": 0, "RatingMethodType": "string", "AggregateRateType": "string", "PropagateInvLevelCharge": 0, "LateFeeAgainstBalance": "string", "DiscountPriority": "string", "EarlyTerminationOption": "string", "ZeroRateBanded": 0, "AccumFlag": "string", "AccumStartDate": "string", "AutoCalculateCredit": 0, "SSPProfileId": 0, "IncludedUsageAmountsId": "string", "QuoteProductDraftId": 0, "QuoteProductId": 0, "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "IncrementAmount": "string", "ExcludeComponents": "string", "NumberOfCharges": "string", "DiscountEligCond": "string", "DefaultRateFlag": 0, "OverrideTypePackage": 0, "commitmentApplicableProduct": "string", "ForbidChargeInPreviousPeriod": 0, "ItemizeTrialDiscounts": "string", "ProductId": 0, "AccountProductId": 0, "OnEndDate": "string", "RenewalOrChangeTerm": "string", "ChangeToProductByDefault": 0, "Created": "string", "AllowInternationalPricing": 0, "ExternalKey": "string" } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"TaxApplicableTo": "string",
"AutoRefill": 0,
"FormulaValue": "string",
"SubscriptionCycle": "string",
"TaxApplication": "string",
"ChargeType": "string",
"CMTTaxFlag": 0,
"EligibleActivityFilterLogic": "string",
"DesignateDiscountEligableChargesBy": "string",
"TrialUsePer": "string",
"TrialTarget": "string",
"ZeroRatedDisplayFlag": "string",
"TaxProductFilterLogic": "string",
"ProrateSubscription": "string",
"DiscountEligUnitMeas": "string",
"FormulaParamIdent": "string",
"TrialDuration": "string",
"ProrateBand": 0,
"FormulaFlag": 0,
"UseHistoricalInvoiceForPrepayment": 0,
"CMTInclusionLogic": "string",
"CMTRateMethod": "string",
"UseFlatRate": "string",
"ChargeInAdvanceUnit": "string",
"MinMaxZeroQuantityTrueUp": 0,
"TaxRateDate": "string",
"DiscountUsePer": "string",
"SubscriptionModel": "string",
"ActivationChargePlace": "string",
"DiscountItemize": 0,
"ProrateCreditAfterPeriod": "string",
"CMTTermDuration": "string",
"DiscountEligableFilterLogic": "string",
"TrialMaxNumberUses": "string",
"ApplyChargeOnComponent": 0,
"TrialRateType": "string",
"FlatRate": 0,
"DiscountLimitedUsage": 0,
"DiscountMaxNumberOfUses": "string",
"CMTScope": "string",
"AccumResetPeriod": "string",
"RecalculateOnRateChange": 0,
"GenerateFlatFee": 0,
"DiscountTargetFilterLogic": "string",
"TrueUpCreditType": "string",
"ChargeInSubsequentPer": "string",
"ObligatoryIntlRate": 0,
"FormulaQuantity": "string",
"PricingType": "string",
"SplitUsage": 0,
"DependentType": "string",
"ForceGenerateActivity": 0,
"DesignateDiscountTargetChargesBy": "string",
"CalculateEffectiveRate": 0,
"NonBillableFlag": 0,
"ChargeInSubsequentUnit": "string",
"LateFeeType": "string",
"SubAggrLevel": "string",
"DiscountType": "string",
"DiscountApplMethod": "string",
"DiscountPricingType": "string",
"TrueUpMethod": "string",
"ChargeInAdvancePeriod": "string",
"MinMaxGenerateOnNegative": 0,
"DiscountApplyTo": "string",
"AggregationLevel": "string",
"IntervalSubscriptionDays": "string",
"CycleType": "string",
"TaxType": "string",
"formulaOnInvoiceClose": 0,
"FormulaFilterLogic": "string",
"SplitBySubAccount": 0,
"CMTInputMethod": "string",
"CMTQuantity": "string",
"TrueUpProduct": 0,
"RatingMethodType": "string",
"AggregateRateType": "string",
"PropagateInvLevelCharge": 0,
"LateFeeAgainstBalance": "string",
"DiscountPriority": "string",
"EarlyTerminationOption": "string",
"ZeroRateBanded": 0,
"AccumFlag": "string",
"AccumStartDate": "string",
"AutoCalculateCredit": 0,
"SSPProfileId": 0,
"IncludedUsageAmountsId": "string",
"QuoteProductDraftId": 0,
"QuoteProductId": 0,
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"IncrementAmount": "string",
"ExcludeComponents": "string",
"NumberOfCharges": "string",
"DiscountEligCond": "string",
"DefaultRateFlag": 0,
"OverrideTypePackage": 0,
"commitmentApplicableProduct": "string",
"ForbidChargeInPreviousPeriod": 0,
"ItemizeTrialDiscounts": "string",
"ProductId": 0,
"AccountProductId": 0,
"OnEndDate": "string",
"RenewalOrChangeTerm": "string",
"ChangeToProductByDefault": 0,
"Created": "string",
"AllowInternationalPricing": 0,
"ExternalKey": "string"
}
}'{ "retrieveResponse": { "TaxApplicableTo": "string", "AutoRefill": 0, "FormulaValue": "string", "SubscriptionCycle": "string", "TaxApplication": "string", "ChargeType": "string", "CMTTaxFlag": 0, "EligibleActivityFilterLogic": "string", "DesignateDiscountEligableChargesBy": "string", "TrialUsePer": "string", "TrialTarget": "string", "ZeroRatedDisplayFlag": "string", "TaxProductFilterLogic": "string", "ProrateSubscription": "string", "DiscountEligUnitMeas": "string", "FormulaParamIdent": "string", "TrialDuration": "string", "ProrateBand": 0, "FormulaFlag": 0, "UseHistoricalInvoiceForPrepayment": 0, "CMTInclusionLogic": "string", "CMTRateMethod": "string", "UseFlatRate": "string", "ChargeInAdvanceUnit": "string", "MinMaxZeroQuantityTrueUp": 0, "TaxRateDate": "string", "DiscountUsePer": "string", "SubscriptionModel": "string", "ActivationChargePlace": "string", "DiscountItemize": 0, "ProrateCreditAfterPeriod": "string", "CMTTermDuration": "string", "DiscountEligableFilterLogic": "string", "TrialMaxNumberUses": "string", "ApplyChargeOnComponent": 0, "TrialRateType": "string", "FlatRate": 0, "DiscountLimitedUsage": 0, "DiscountMaxNumberOfUses": "string", "CMTScope": "string", "AccumResetPeriod": "string", "RecalculateOnRateChange": 0, "GenerateFlatFee": 0, "DiscountTargetFilterLogic": "string", "TrueUpCreditType": "string", "ChargeInSubsequentPer": "string", "ObligatoryIntlRate": 0, "FormulaQuantity": "string", "PricingType": "string", "SplitUsage": 0, "DependentType": "string", "ForceGenerateActivity": 0, "DesignateDiscountTargetChargesBy": "string", "CalculateEffectiveRate": 0, "NonBillableFlag": 0, "ChargeInSubsequentUnit": "string", "LateFeeType": "string", "SubAggrLevel": "string", "DiscountType": "string", "DiscountApplMethod": "string", "DiscountPricingType": "string", "TrueUpMethod": "string", "ChargeInAdvancePeriod": "string", "MinMaxGenerateOnNegative": 0, "DiscountApplyTo": "string", "AggregationLevel": "string", "IntervalSubscriptionDays": "string", "CycleType": "string", "TaxType": "string", "formulaOnInvoiceClose": 0, "FormulaFilterLogic": "string", "SplitBySubAccount": 0, "CMTInputMethod": "string", "CMTQuantity": "string", "TrueUpProduct": 0, "RatingMethodType": "string", "AggregateRateType": "string", "PropagateInvLevelCharge": 0, "LateFeeAgainstBalance": "string", "DiscountPriority": "string", "EarlyTerminationOption": "string", "ZeroRateBanded": 0, "AccumFlag": "string", "AccumStartDate": "string", "AutoCalculateCredit": 0, "SSPProfileId": 0, "IncludedUsageAmountsId": "string", "QuoteProductDraftId": 0, "QuoteProductId": 0, "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "IncrementAmount": "string", "ExcludeComponents": "string", "NumberOfCharges": "string", "DiscountEligCond": "string", "DefaultRateFlag": 0, "OverrideTypePackage": 0, "commitmentApplicableProduct": "string", "ForbidChargeInPreviousPeriod": 0, "ItemizeTrialDiscounts": "string", "ProductId": 0, "AccountProductId": 0, "OnEndDate": "string", "RenewalOrChangeTerm": "string", "ChangeToProductByDefault": 0, "Created": "string", "AllowInternationalPricing": 0, "ExternalKey": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"TaxApplicableTo": "string",
"AutoRefill": 0,
"FormulaValue": "string",
"SubscriptionCycle": "string",
"TaxApplication": "string",
"ChargeType": "string",
"CMTTaxFlag": 0,
"EligibleActivityFilterLogic": "string",
"DesignateDiscountEligableChargesBy": "string",
"TrialUsePer": "string",
"TrialTarget": "string",
"ZeroRatedDisplayFlag": "string",
"TaxProductFilterLogic": "string",
"ProrateSubscription": "string",
"DiscountEligUnitMeas": "string",
"FormulaParamIdent": "string",
"TrialDuration": "string",
"ProrateBand": 0,
"FormulaFlag": 0,
"UseHistoricalInvoiceForPrepayment": 0,
"CMTInclusionLogic": "string",
"CMTRateMethod": "string",
"UseFlatRate": "string",
"ChargeInAdvanceUnit": "string",
"MinMaxZeroQuantityTrueUp": 0,
"TaxRateDate": "string",
"DiscountUsePer": "string",
"SubscriptionModel": "string",
"ActivationChargePlace": "string",
"DiscountItemize": 0,
"ProrateCreditAfterPeriod": "string",
"CMTTermDuration": "string",
"DiscountEligableFilterLogic": "string",
"TrialMaxNumberUses": "string",
"ApplyChargeOnComponent": 0,
"TrialRateType": "string",
"FlatRate": 0,
"DiscountLimitedUsage": 0,
"DiscountMaxNumberOfUses": "string",
"CMTScope": "string",
"AccumResetPeriod": "string",
"RecalculateOnRateChange": 0,
"GenerateFlatFee": 0,
"DiscountTargetFilterLogic": "string",
"TrueUpCreditType": "string",
"ChargeInSubsequentPer": "string",
"ObligatoryIntlRate": 0,
"FormulaQuantity": "string",
"PricingType": "string",
"SplitUsage": 0,
"DependentType": "string",
"ForceGenerateActivity": 0,
"DesignateDiscountTargetChargesBy": "string",
"CalculateEffectiveRate": 0,
"NonBillableFlag": 0,
"ChargeInSubsequentUnit": "string",
"LateFeeType": "string",
"SubAggrLevel": "string",
"DiscountType": "string",
"DiscountApplMethod": "string",
"DiscountPricingType": "string",
"TrueUpMethod": "string",
"ChargeInAdvancePeriod": "string",
"MinMaxGenerateOnNegative": 0,
"DiscountApplyTo": "string",
"AggregationLevel": "string",
"IntervalSubscriptionDays": "string",
"CycleType": "string",
"TaxType": "string",
"formulaOnInvoiceClose": 0,
"FormulaFilterLogic": "string",
"SplitBySubAccount": 0,
"CMTInputMethod": "string",
"CMTQuantity": "string",
"TrueUpProduct": 0,
"RatingMethodType": "string",
"AggregateRateType": "string",
"PropagateInvLevelCharge": 0,
"LateFeeAgainstBalance": "string",
"DiscountPriority": "string",
"EarlyTerminationOption": "string",
"ZeroRateBanded": 0,
"AccumFlag": "string",
"AccumStartDate": "string",
"AutoCalculateCredit": 0,
"SSPProfileId": 0,
"IncludedUsageAmountsId": "string",
"QuoteProductDraftId": 0,
"QuoteProductId": 0,
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"IncrementAmount": "string",
"ExcludeComponents": "string",
"NumberOfCharges": "string",
"DiscountEligCond": "string",
"DefaultRateFlag": 0,
"OverrideTypePackage": 0,
"commitmentApplicableProduct": "string",
"ForbidChargeInPreviousPeriod": 0,
"ItemizeTrialDiscounts": "string",
"ProductId": 0,
"AccountProductId": 0,
"OnEndDate": "string",
"RenewalOrChangeTerm": "string",
"ChangeToProductByDefault": 0,
"Created": "string",
"AllowInternationalPricing": 0,
"ExternalKey": "string"
}
}'{ "retrieveResponse": { "TaxApplicableTo": "string", "AutoRefill": 0, "FormulaValue": "string", "SubscriptionCycle": "string", "TaxApplication": "string", "ChargeType": "string", "CMTTaxFlag": 0, "EligibleActivityFilterLogic": "string", "DesignateDiscountEligableChargesBy": "string", "TrialUsePer": "string", "TrialTarget": "string", "ZeroRatedDisplayFlag": "string", "TaxProductFilterLogic": "string", "ProrateSubscription": "string", "DiscountEligUnitMeas": "string", "FormulaParamIdent": "string", "TrialDuration": "string", "ProrateBand": 0, "FormulaFlag": 0, "UseHistoricalInvoiceForPrepayment": 0, "CMTInclusionLogic": "string", "CMTRateMethod": "string", "UseFlatRate": "string", "ChargeInAdvanceUnit": "string", "MinMaxZeroQuantityTrueUp": 0, "TaxRateDate": "string", "DiscountUsePer": "string", "SubscriptionModel": "string", "ActivationChargePlace": "string", "DiscountItemize": 0, "ProrateCreditAfterPeriod": "string", "CMTTermDuration": "string", "DiscountEligableFilterLogic": "string", "TrialMaxNumberUses": "string", "ApplyChargeOnComponent": 0, "TrialRateType": "string", "FlatRate": 0, "DiscountLimitedUsage": 0, "DiscountMaxNumberOfUses": "string", "CMTScope": "string", "AccumResetPeriod": "string", "RecalculateOnRateChange": 0, "GenerateFlatFee": 0, "DiscountTargetFilterLogic": "string", "TrueUpCreditType": "string", "ChargeInSubsequentPer": "string", "ObligatoryIntlRate": 0, "FormulaQuantity": "string", "PricingType": "string", "SplitUsage": 0, "DependentType": "string", "ForceGenerateActivity": 0, "DesignateDiscountTargetChargesBy": "string", "CalculateEffectiveRate": 0, "NonBillableFlag": 0, "ChargeInSubsequentUnit": "string", "LateFeeType": "string", "SubAggrLevel": "string", "DiscountType": "string", "DiscountApplMethod": "string", "DiscountPricingType": "string", "TrueUpMethod": "string", "ChargeInAdvancePeriod": "string", "MinMaxGenerateOnNegative": 0, "DiscountApplyTo": "string", "AggregationLevel": "string", "IntervalSubscriptionDays": "string", "CycleType": "string", "TaxType": "string", "formulaOnInvoiceClose": 0, "FormulaFilterLogic": "string", "SplitBySubAccount": 0, "CMTInputMethod": "string", "CMTQuantity": "string", "TrueUpProduct": 0, "RatingMethodType": "string", "AggregateRateType": "string", "PropagateInvLevelCharge": 0, "LateFeeAgainstBalance": "string", "DiscountPriority": "string", "EarlyTerminationOption": "string", "ZeroRateBanded": 0, "AccumFlag": "string", "AccumStartDate": "string", "AutoCalculateCredit": 0, "SSPProfileId": 0, "IncludedUsageAmountsId": "string", "QuoteProductDraftId": 0, "QuoteProductId": 0, "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "IncrementAmount": "string", "ExcludeComponents": "string", "NumberOfCharges": "string", "DiscountEligCond": "string", "DefaultRateFlag": 0, "OverrideTypePackage": 0, "commitmentApplicableProduct": "string", "ForbidChargeInPreviousPeriod": 0, "ItemizeTrialDiscounts": "string", "ProductId": 0, "AccountProductId": 0, "OnEndDate": "string", "RenewalOrChangeTerm": "string", "ChangeToProductByDefault": 0, "Created": "string", "AllowInternationalPricing": 0, "ExternalKey": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"TaxApplicableTo": "string",
"AutoRefill": 0,
"FormulaValue": "string",
"SubscriptionCycle": "string",
"TaxApplication": "string",
"ChargeType": "string",
"CMTTaxFlag": 0,
"EligibleActivityFilterLogic": "string",
"DesignateDiscountEligableChargesBy": "string",
"TrialUsePer": "string",
"TrialTarget": "string",
"ZeroRatedDisplayFlag": "string",
"TaxProductFilterLogic": "string",
"ProrateSubscription": "string",
"DiscountEligUnitMeas": "string",
"FormulaParamIdent": "string",
"TrialDuration": "string",
"ProrateBand": 0,
"FormulaFlag": 0,
"UseHistoricalInvoiceForPrepayment": 0,
"CMTInclusionLogic": "string",
"CMTRateMethod": "string",
"UseFlatRate": "string",
"ChargeInAdvanceUnit": "string",
"MinMaxZeroQuantityTrueUp": 0,
"TaxRateDate": "string",
"DiscountUsePer": "string",
"SubscriptionModel": "string",
"ActivationChargePlace": "string",
"DiscountItemize": 0,
"ProrateCreditAfterPeriod": "string",
"CMTTermDuration": "string",
"DiscountEligableFilterLogic": "string",
"TrialMaxNumberUses": "string",
"ApplyChargeOnComponent": 0,
"TrialRateType": "string",
"FlatRate": 0,
"DiscountLimitedUsage": 0,
"DiscountMaxNumberOfUses": "string",
"CMTScope": "string",
"AccumResetPeriod": "string",
"RecalculateOnRateChange": 0,
"GenerateFlatFee": 0,
"DiscountTargetFilterLogic": "string",
"TrueUpCreditType": "string",
"ChargeInSubsequentPer": "string",
"ObligatoryIntlRate": 0,
"FormulaQuantity": "string",
"PricingType": "string",
"SplitUsage": 0,
"DependentType": "string",
"ForceGenerateActivity": 0,
"DesignateDiscountTargetChargesBy": "string",
"CalculateEffectiveRate": 0,
"NonBillableFlag": 0,
"ChargeInSubsequentUnit": "string",
"LateFeeType": "string",
"SubAggrLevel": "string",
"DiscountType": "string",
"DiscountApplMethod": "string",
"DiscountPricingType": "string",
"TrueUpMethod": "string",
"ChargeInAdvancePeriod": "string",
"MinMaxGenerateOnNegative": 0,
"DiscountApplyTo": "string",
"AggregationLevel": "string",
"IntervalSubscriptionDays": "string",
"CycleType": "string",
"TaxType": "string",
"formulaOnInvoiceClose": 0,
"FormulaFilterLogic": "string",
"SplitBySubAccount": 0,
"CMTInputMethod": "string",
"CMTQuantity": "string",
"TrueUpProduct": 0,
"RatingMethodType": "string",
"AggregateRateType": "string",
"PropagateInvLevelCharge": 0,
"LateFeeAgainstBalance": "string",
"DiscountPriority": "string",
"EarlyTerminationOption": "string",
"ZeroRateBanded": 0,
"AccumFlag": "string",
"AccumStartDate": "string",
"AutoCalculateCredit": 0,
"SSPProfileId": 0,
"IncludedUsageAmountsId": "string",
"QuoteProductDraftId": 0,
"QuoteProductId": 0,
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"IncrementAmount": "string",
"ExcludeComponents": "string",
"NumberOfCharges": "string",
"DiscountEligCond": "string",
"DefaultRateFlag": 0,
"OverrideTypePackage": 0,
"commitmentApplicableProduct": "string",
"ForbidChargeInPreviousPeriod": 0,
"ItemizeTrialDiscounts": "string",
"ProductId": 0,
"AccountProductId": 0,
"OnEndDate": "string",
"RenewalOrChangeTerm": "string",
"ChangeToProductByDefault": 0,
"Created": "string",
"AllowInternationalPricing": 0,
"ExternalKey": "string"
},
"externalIDFieldName": "QuoteProductDraftId"
}'{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'{ "retrieveResponse": { "TaxApplicableTo": "string", "AutoRefill": 0, "FormulaValue": "string", "SubscriptionCycle": "string", "TaxApplication": "string", "ChargeType": "string", "CMTTaxFlag": 0, "EligibleActivityFilterLogic": "string", "DesignateDiscountEligableChargesBy": "string", "TrialUsePer": "string", "TrialTarget": "string", "ZeroRatedDisplayFlag": "string", "TaxProductFilterLogic": "string", "ProrateSubscription": "string", "DiscountEligUnitMeas": "string", "FormulaParamIdent": "string", "TrialDuration": "string", "ProrateBand": 0, "FormulaFlag": 0, "UseHistoricalInvoiceForPrepayment": 0, "CMTInclusionLogic": "string", "CMTRateMethod": "string", "UseFlatRate": "string", "ChargeInAdvanceUnit": "string", "MinMaxZeroQuantityTrueUp": 0, "TaxRateDate": "string", "DiscountUsePer": "string", "SubscriptionModel": "string", "ActivationChargePlace": "string", "DiscountItemize": 0, "ProrateCreditAfterPeriod": "string", "CMTTermDuration": "string", "DiscountEligableFilterLogic": "string", "TrialMaxNumberUses": "string", "ApplyChargeOnComponent": 0, "TrialRateType": "string", "FlatRate": 0, "DiscountLimitedUsage": 0, "DiscountMaxNumberOfUses": "string", "CMTScope": "string", "AccumResetPeriod": "string", "RecalculateOnRateChange": 0, "GenerateFlatFee": 0, "DiscountTargetFilterLogic": "string", "TrueUpCreditType": "string", "ChargeInSubsequentPer": "string", "ObligatoryIntlRate": 0, "FormulaQuantity": "string", "PricingType": "string", "SplitUsage": 0, "DependentType": "string", "ForceGenerateActivity": 0, "DesignateDiscountTargetChargesBy": "string", "CalculateEffectiveRate": 0, "NonBillableFlag": 0, "ChargeInSubsequentUnit": "string", "LateFeeType": "string", "SubAggrLevel": "string", "DiscountType": "string", "DiscountApplMethod": "string", "DiscountPricingType": "string", "TrueUpMethod": "string", "ChargeInAdvancePeriod": "string", "MinMaxGenerateOnNegative": 0, "DiscountApplyTo": "string", "AggregationLevel": "string", "IntervalSubscriptionDays": "string", "CycleType": "string", "TaxType": "string", "formulaOnInvoiceClose": 0, "FormulaFilterLogic": "string", "SplitBySubAccount": 0, "CMTInputMethod": "string", "CMTQuantity": "string", "TrueUpProduct": 0, "RatingMethodType": "string", "AggregateRateType": "string", "PropagateInvLevelCharge": 0, "LateFeeAgainstBalance": "string", "DiscountPriority": "string", "EarlyTerminationOption": "string", "ZeroRateBanded": 0, "AccumFlag": "string", "AccumStartDate": "string", "AutoCalculateCredit": 0, "SSPProfileId": 0, "IncludedUsageAmountsId": "string", "QuoteProductDraftId": 0, "QuoteProductId": 0, "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "IncrementAmount": "string", "ExcludeComponents": "string", "NumberOfCharges": "string", "DiscountEligCond": "string", "DefaultRateFlag": 0, "OverrideTypePackage": 0, "commitmentApplicableProduct": "string", "ForbidChargeInPreviousPeriod": 0, "ItemizeTrialDiscounts": "string", "ProductId": 0, "AccountProductId": 0, "OnEndDate": "string", "RenewalOrChangeTerm": "string", "ChangeToProductByDefault": 0, "Created": "string", "AllowInternationalPricing": 0, "ExternalKey": "string" } }
An Account is a fundamental entity used for billing customers. It plays a crucial role in various billing and invoicing processes. Each Account is associated with an Account Type, Activity Time Zone, and Country. The AllowPricingInDifferentCurrency field determines if pricing can be in a currency different from the default. The Account can be linked to other entities such as Billable Account, Billing Profile, Collector User, and Parent Account. The Billable Account and Billing Profile are essential for invoicing and payment information. The Collector User field identifies the user responsible for collecting payments.