API Reference (1.0)
Billing Platform API
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccumFlag": null,
"AccumResetPeriod": null,
"AccumStartDate": null,
"ActivationChargePlace": null,
"AggregateRateType": null,
"AggregationLevel": null,
"AllowInternationalPricing": null,
"ApplyChargeOnComponent": null,
"AutoCalculateCredit": null,
"AutoRefill": null,
"CMTInclusionLogic": null,
"CMTInputMethod": null,
"CMTQuantity": null,
"CMTRateMethod": null,
"CMTScope": null,
"CMTTaxFlag": null,
"CMTTermDuration": null,
"CalculateEffectiveRate": null,
"ChangeToProductByDefault": null,
"ChargeInAdvancePeriod": null,
"ChargeInAdvanceUnit": null,
"ChargeInSubsequentPer": null,
"ChargeInSubsequentUnit": null,
"ChargeType": null,
"Created": null,
"CreatedUserId": null,
"CycleType": null,
"DefaultRateFlag": null,
"DependentType": null,
"DesignateDiscountEligableChargesBy": null,
"DesignateDiscountTargetChargesBy": null,
"DiscountApplMethod": null,
"DiscountApplyTo": null,
"DiscountEligCond": null,
"DiscountEligUnitMeas": null,
"DiscountEligableFilterLogic": null,
"DiscountItemize": null,
"DiscountLimitedUsage": null,
"DiscountMaxNumberOfUses": null,
"DiscountPricingType": null,
"DiscountPriority": null,
"DiscountTargetFilterLogic": null,
"DiscountType": null,
"DiscountUsePer": null,
"EarlyTerminationOption": null,
"EffectiveDate": null,
"EligibleActivityFilterLogic": null,
"EndDate": null,
"ExcludeComponents": null,
"ExternalKey": null,
"FlatRate": null,
"ForbidChargeInPreviousPeriod": null,
"ForceGenerateActivity": null,
"FormulaFilterLogic": null,
"FormulaFlag": null,
"FormulaParamIdent": null,
"FormulaQuantity": null,
"FormulaValue": null,
"GenerateFlatFee": null,
"Id": null,
"IncludedUsageAmountsId": null,
"IncrementAmount": null,
"IntervalSubscriptionDays": null,
"ItemizeTrialDiscounts": null,
"LateFeeAgainstBalance": null,
"LateFeeType": null,
"MinMaxGenerateOnNegative": null,
"MinMaxZeroQuantityTrueUp": null,
"NonBillableFlag": null,
"NumberOfCharges": null,
"ObligatoryIntlRate": null,
"OnEndDate": null,
"OverrideTypePackage": null,
"PricingType": null,
"ProductId": null,
"PropagateInvLevelCharge": null,
"ProrateBand": null,
"ProrateCreditAfterPeriod": null,
"ProrateSubscription": null,
"QuoteProductDraftId": null,
"QuoteProductId": null,
"RatingMethodType": null,
"RecalculateOnRateChange": null,
"RenewalOrChangeTerm": null,
"SSPProfileId": null,
"SplitBySubAccount": null,
"SplitUsage": null,
"SubAggrLevel": null,
"SubscriptionCycle": null,
"SubscriptionDiscountDate": null,
"SubscriptionModel": null,
"TaxApplicableTo": null,
"TaxApplication": null,
"TaxProductFilterLogic": null,
"TaxRateDate": null,
"TaxType": null,
"TrialDuration": null,
"TrialMaxNumberUses": null,
"TrialRateType": null,
"TrialTarget": null,
"TrialUsePer": null,
"TrueUpCreditType": null,
"TrueUpMethod": null,
"TrueUpProduct": null,
"Updated": null,
"UpdatedUserId": null,
"UseFlatRate": null,
"UseHistoricalInvoiceForPrepayment": null,
"ZeroRateBanded": null,
"ZeroRatedDisplayFlag": null,
"commitmentApplicableProduct": null,
"formulaOnInvoiceClose": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccumFlag": null,
"AccumResetPeriod": null,
"AccumStartDate": null,
"ActivationChargePlace": null,
"AggregateRateType": null,
"AggregationLevel": null,
"AllowInternationalPricing": null,
"ApplyChargeOnComponent": null,
"AutoCalculateCredit": null,
"AutoRefill": null,
"CMTInclusionLogic": null,
"CMTInputMethod": null,
"CMTQuantity": null,
"CMTRateMethod": null,
"CMTScope": null,
"CMTTaxFlag": null,
"CMTTermDuration": null,
"CalculateEffectiveRate": null,
"ChangeToProductByDefault": null,
"ChargeInAdvancePeriod": null,
"ChargeInAdvanceUnit": null,
"ChargeInSubsequentPer": null,
"ChargeInSubsequentUnit": null,
"ChargeType": null,
"Created": null,
"CreatedUserId": null,
"CycleType": null,
"DefaultRateFlag": null,
"DependentType": null,
"DesignateDiscountEligableChargesBy": null,
"DesignateDiscountTargetChargesBy": null,
"DiscountApplMethod": null,
"DiscountApplyTo": null,
"DiscountEligCond": null,
"DiscountEligUnitMeas": null,
"DiscountEligableFilterLogic": null,
"DiscountItemize": null,
"DiscountLimitedUsage": null,
"DiscountMaxNumberOfUses": null,
"DiscountPricingType": null,
"DiscountPriority": null,
"DiscountTargetFilterLogic": null,
"DiscountType": null,
"DiscountUsePer": null,
"EarlyTerminationOption": null,
"EffectiveDate": null,
"EligibleActivityFilterLogic": null,
"EndDate": null,
"ExcludeComponents": null,
"ExternalKey": null,
"FlatRate": null,
"ForbidChargeInPreviousPeriod": null,
"ForceGenerateActivity": null,
"FormulaFilterLogic": null,
"FormulaFlag": null,
"FormulaParamIdent": null,
"FormulaQuantity": null,
"FormulaValue": null,
"GenerateFlatFee": null,
"Id": null,
"IncludedUsageAmountsId": null,
"IncrementAmount": null,
"IntervalSubscriptionDays": null,
"ItemizeTrialDiscounts": null,
"LateFeeAgainstBalance": null,
"LateFeeType": null,
"MinMaxGenerateOnNegative": null,
"MinMaxZeroQuantityTrueUp": null,
"NonBillableFlag": null,
"NumberOfCharges": null,
"ObligatoryIntlRate": null,
"OnEndDate": null,
"OverrideTypePackage": null,
"PricingType": null,
"ProductId": null,
"PropagateInvLevelCharge": null,
"ProrateBand": null,
"ProrateCreditAfterPeriod": null,
"ProrateSubscription": null,
"QuoteProductDraftId": null,
"QuoteProductId": null,
"RatingMethodType": null,
"RecalculateOnRateChange": null,
"RenewalOrChangeTerm": null,
"SSPProfileId": null,
"SplitBySubAccount": null,
"SplitUsage": null,
"SubAggrLevel": null,
"SubscriptionCycle": null,
"SubscriptionDiscountDate": null,
"SubscriptionModel": null,
"TaxApplicableTo": null,
"TaxApplication": null,
"TaxProductFilterLogic": null,
"TaxRateDate": null,
"TaxType": null,
"TrialDuration": null,
"TrialMaxNumberUses": null,
"TrialRateType": null,
"TrialTarget": null,
"TrialUsePer": null,
"TrueUpCreditType": null,
"TrueUpMethod": null,
"TrueUpProduct": null,
"Updated": null,
"UpdatedUserId": null,
"UseFlatRate": null,
"UseHistoricalInvoiceForPrepayment": null,
"ZeroRateBanded": null,
"ZeroRatedDisplayFlag": null,
"commitmentApplicableProduct": null,
"formulaOnInvoiceClose": null
},
"externalIDFieldName": "AccountProductId"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/delete/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/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"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccumFlag": null,
"AccumResetPeriod": null,
"AccumStartDate": null,
"ActivationChargePlace": null,
"AggregateRateType": null,
"AggregationLevel": null,
"AllowInternationalPricing": null,
"ApplyChargeOnComponent": null,
"AutoCalculateCredit": null,
"AutoRefill": null,
"CMTInclusionLogic": null,
"CMTInputMethod": null,
"CMTQuantity": null,
"CMTRateMethod": null,
"CMTScope": null,
"CMTTaxFlag": null,
"CMTTermDuration": null,
"CalculateEffectiveRate": null,
"ChangeToProductByDefault": null,
"ChargeInAdvancePeriod": null,
"ChargeInAdvanceUnit": null,
"ChargeInSubsequentPer": null,
"ChargeInSubsequentUnit": null,
"ChargeType": null,
"Created": null,
"CreatedUserId": null,
"CycleType": null,
"DefaultRateFlag": null,
"DependentType": null,
"DesignateDiscountEligableChargesBy": null,
"DesignateDiscountTargetChargesBy": null,
"DiscountApplMethod": null,
"DiscountApplyTo": null,
"DiscountEligCond": null,
"DiscountEligUnitMeas": null,
"DiscountEligableFilterLogic": null,
"DiscountItemize": null,
"DiscountLimitedUsage": null,
"DiscountMaxNumberOfUses": null,
"DiscountPricingType": null,
"DiscountPriority": null,
"DiscountTargetFilterLogic": null,
"DiscountType": null,
"DiscountUsePer": null,
"EarlyTerminationOption": null,
"EffectiveDate": null,
"EligibleActivityFilterLogic": null,
"EndDate": null,
"ExcludeComponents": null,
"ExternalKey": null,
"FlatRate": null,
"ForbidChargeInPreviousPeriod": null,
"ForceGenerateActivity": null,
"FormulaFilterLogic": null,
"FormulaFlag": null,
"FormulaParamIdent": null,
"FormulaQuantity": null,
"FormulaValue": null,
"GenerateFlatFee": null,
"Id": null,
"IncludedUsageAmountsId": null,
"IncrementAmount": null,
"IntervalSubscriptionDays": null,
"ItemizeTrialDiscounts": null,
"LateFeeAgainstBalance": null,
"LateFeeType": null,
"MinMaxGenerateOnNegative": null,
"MinMaxZeroQuantityTrueUp": null,
"NonBillableFlag": null,
"NumberOfCharges": null,
"ObligatoryIntlRate": null,
"OnEndDate": null,
"OverrideTypePackage": null,
"PricingType": null,
"ProductId": null,
"PropagateInvLevelCharge": null,
"ProrateBand": null,
"ProrateCreditAfterPeriod": null,
"ProrateSubscription": null,
"QuoteProductDraftId": null,
"QuoteProductId": null,
"RatingMethodType": null,
"RecalculateOnRateChange": null,
"RenewalOrChangeTerm": null,
"SSPProfileId": null,
"SplitBySubAccount": null,
"SplitUsage": null,
"SubAggrLevel": null,
"SubscriptionCycle": null,
"SubscriptionDiscountDate": null,
"SubscriptionModel": null,
"TaxApplicableTo": null,
"TaxApplication": null,
"TaxProductFilterLogic": null,
"TaxRateDate": null,
"TaxType": null,
"TrialDuration": null,
"TrialMaxNumberUses": null,
"TrialRateType": null,
"TrialTarget": null,
"TrialUsePer": null,
"TrueUpCreditType": null,
"TrueUpMethod": null,
"TrueUpProduct": null,
"Updated": null,
"UpdatedUserId": null,
"UseFlatRate": null,
"UseHistoricalInvoiceForPrepayment": null,
"ZeroRateBanded": null,
"ZeroRatedDisplayFlag": null,
"commitmentApplicableProduct": null,
"formulaOnInvoiceClose": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/RATING_METHOD \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccumFlag": null,
"AccumResetPeriod": null,
"AccumStartDate": null,
"ActivationChargePlace": null,
"AggregateRateType": null,
"AggregationLevel": null,
"AllowInternationalPricing": null,
"ApplyChargeOnComponent": null,
"AutoCalculateCredit": null,
"AutoRefill": null,
"CMTInclusionLogic": null,
"CMTInputMethod": null,
"CMTQuantity": null,
"CMTRateMethod": null,
"CMTScope": null,
"CMTTaxFlag": null,
"CMTTermDuration": null,
"CalculateEffectiveRate": null,
"ChangeToProductByDefault": null,
"ChargeInAdvancePeriod": null,
"ChargeInAdvanceUnit": null,
"ChargeInSubsequentPer": null,
"ChargeInSubsequentUnit": null,
"ChargeType": null,
"Created": null,
"CreatedUserId": null,
"CycleType": null,
"DefaultRateFlag": null,
"DependentType": null,
"DesignateDiscountEligableChargesBy": null,
"DesignateDiscountTargetChargesBy": null,
"DiscountApplMethod": null,
"DiscountApplyTo": null,
"DiscountEligCond": null,
"DiscountEligUnitMeas": null,
"DiscountEligableFilterLogic": null,
"DiscountItemize": null,
"DiscountLimitedUsage": null,
"DiscountMaxNumberOfUses": null,
"DiscountPricingType": null,
"DiscountPriority": null,
"DiscountTargetFilterLogic": null,
"DiscountType": null,
"DiscountUsePer": null,
"EarlyTerminationOption": null,
"EffectiveDate": null,
"EligibleActivityFilterLogic": null,
"EndDate": null,
"ExcludeComponents": null,
"ExternalKey": null,
"FlatRate": null,
"ForbidChargeInPreviousPeriod": null,
"ForceGenerateActivity": null,
"FormulaFilterLogic": null,
"FormulaFlag": null,
"FormulaParamIdent": null,
"FormulaQuantity": null,
"FormulaValue": null,
"GenerateFlatFee": null,
"Id": null,
"IncludedUsageAmountsId": null,
"IncrementAmount": null,
"IntervalSubscriptionDays": null,
"ItemizeTrialDiscounts": null,
"LateFeeAgainstBalance": null,
"LateFeeType": null,
"MinMaxGenerateOnNegative": null,
"MinMaxZeroQuantityTrueUp": null,
"NonBillableFlag": null,
"NumberOfCharges": null,
"ObligatoryIntlRate": null,
"OnEndDate": null,
"OverrideTypePackage": null,
"PricingType": null,
"ProductId": null,
"PropagateInvLevelCharge": null,
"ProrateBand": null,
"ProrateCreditAfterPeriod": null,
"ProrateSubscription": null,
"QuoteProductDraftId": null,
"QuoteProductId": null,
"RatingMethodType": null,
"RecalculateOnRateChange": null,
"RenewalOrChangeTerm": null,
"SSPProfileId": null,
"SplitBySubAccount": null,
"SplitUsage": null,
"SubAggrLevel": null,
"SubscriptionCycle": null,
"SubscriptionDiscountDate": null,
"SubscriptionModel": null,
"TaxApplicableTo": null,
"TaxApplication": null,
"TaxProductFilterLogic": null,
"TaxRateDate": null,
"TaxType": null,
"TrialDuration": null,
"TrialMaxNumberUses": null,
"TrialRateType": null,
"TrialTarget": null,
"TrialUsePer": null,
"TrueUpCreditType": null,
"TrueUpMethod": null,
"TrueUpProduct": null,
"Updated": null,
"UpdatedUserId": null,
"UseFlatRate": null,
"UseHistoricalInvoiceForPrepayment": null,
"ZeroRateBanded": null,
"ZeroRatedDisplayFlag": null,
"commitmentApplicableProduct": null,
"formulaOnInvoiceClose": null
},
"externalIDFieldName": "AccountProductId"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/RATING_METHOD
https://my.billingplatform.com/demogm/rest/2.0/delete/RATING_METHOD
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/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"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }