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/PRICING/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "RerateFlag": 0, "OrderLineItemId": 0, "RateSource": "string", "ExternalKey": "string", "RateClassProductId": 0, "Id": "string", "Rate": "string", "Created": "string", "BuyRate": "string", "MinCharge": "string", "UpperBand": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ProductId": 0, "AccountProductId": 0, "CurrencyCode": 0, "ContractRateId": 0, "EffectiveDate": "string", "EndDate": "string", "BlockSize": "string", "BlockIterations": "string", "RateOrder": "string", "MainPricingPlanId": 0, "QuoteProductId": 0, "QuoteRate": "string", "SSP": "string", "RevRecContractProductId": 0, "PackageProductId": 0, "LowerBand": "string" } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRICING?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "RerateFlag": 0, "OrderLineItemId": 0, "RateSource": "string", "ExternalKey": "string", "RateClassProductId": 0, "Id": "string", "Rate": "string", "Created": "string", "BuyRate": "string", "MinCharge": "string", "UpperBand": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ProductId": 0, "AccountProductId": 0, "CurrencyCode": 0, "ContractRateId": 0, "EffectiveDate": "string", "EndDate": "string", "BlockSize": "string", "BlockIterations": "string", "RateOrder": "string", "MainPricingPlanId": 0, "QuoteProductId": 0, "QuoteRate": "string", "SSP": "string", "RevRecContractProductId": 0, "PackageProductId": 0, "LowerBand": "string" } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRICING \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"RerateFlag": 0,
"OrderLineItemId": 0,
"RateSource": "string",
"ExternalKey": "string",
"RateClassProductId": 0,
"Id": "string",
"Rate": "string",
"Created": "string",
"BuyRate": "string",
"MinCharge": "string",
"UpperBand": "string",
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"ProductId": 0,
"AccountProductId": 0,
"CurrencyCode": 0,
"ContractRateId": 0,
"EffectiveDate": "string",
"EndDate": "string",
"BlockSize": "string",
"BlockIterations": "string",
"RateOrder": "string",
"MainPricingPlanId": 0,
"QuoteProductId": 0,
"QuoteRate": "string",
"SSP": "string",
"RevRecContractProductId": 0,
"PackageProductId": 0,
"LowerBand": "string"
}
}'
{ "retrieveResponse": { "RerateFlag": 0, "OrderLineItemId": 0, "RateSource": "string", "ExternalKey": "string", "RateClassProductId": 0, "Id": "string", "Rate": "string", "Created": "string", "BuyRate": "string", "MinCharge": "string", "UpperBand": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ProductId": 0, "AccountProductId": 0, "CurrencyCode": 0, "ContractRateId": 0, "EffectiveDate": "string", "EndDate": "string", "BlockSize": "string", "BlockIterations": "string", "RateOrder": "string", "MainPricingPlanId": 0, "QuoteProductId": 0, "QuoteRate": "string", "SSP": "string", "RevRecContractProductId": 0, "PackageProductId": 0, "LowerBand": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRICING \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"RerateFlag": 0,
"OrderLineItemId": 0,
"RateSource": "string",
"ExternalKey": "string",
"RateClassProductId": 0,
"Id": "string",
"Rate": "string",
"Created": "string",
"BuyRate": "string",
"MinCharge": "string",
"UpperBand": "string",
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"ProductId": 0,
"AccountProductId": 0,
"CurrencyCode": 0,
"ContractRateId": 0,
"EffectiveDate": "string",
"EndDate": "string",
"BlockSize": "string",
"BlockIterations": "string",
"RateOrder": "string",
"MainPricingPlanId": 0,
"QuoteProductId": 0,
"QuoteRate": "string",
"SSP": "string",
"RevRecContractProductId": 0,
"PackageProductId": 0,
"LowerBand": "string"
}
}'
{ "retrieveResponse": { "RerateFlag": 0, "OrderLineItemId": 0, "RateSource": "string", "ExternalKey": "string", "RateClassProductId": 0, "Id": "string", "Rate": "string", "Created": "string", "BuyRate": "string", "MinCharge": "string", "UpperBand": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ProductId": 0, "AccountProductId": 0, "CurrencyCode": 0, "ContractRateId": 0, "EffectiveDate": "string", "EndDate": "string", "BlockSize": "string", "BlockIterations": "string", "RateOrder": "string", "MainPricingPlanId": 0, "QuoteProductId": 0, "QuoteRate": "string", "SSP": "string", "RevRecContractProductId": 0, "PackageProductId": 0, "LowerBand": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/PRICING \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"RerateFlag": 0,
"OrderLineItemId": 0,
"RateSource": "string",
"ExternalKey": "string",
"RateClassProductId": 0,
"Id": "string",
"Rate": "string",
"Created": "string",
"BuyRate": "string",
"MinCharge": "string",
"UpperBand": "string",
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"ProductId": 0,
"AccountProductId": 0,
"CurrencyCode": 0,
"ContractRateId": 0,
"EffectiveDate": "string",
"EndDate": "string",
"BlockSize": "string",
"BlockIterations": "string",
"RateOrder": "string",
"MainPricingPlanId": 0,
"QuoteProductId": 0,
"QuoteRate": "string",
"SSP": "string",
"RevRecContractProductId": 0,
"PackageProductId": 0,
"LowerBand": "string"
},
"externalIDFieldName": "ExternalKey"
}'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/PRICING \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
{ "retrieveResponse": { "RerateFlag": 0, "OrderLineItemId": 0, "RateSource": "string", "ExternalKey": "string", "RateClassProductId": 0, "Id": "string", "Rate": "string", "Created": "string", "BuyRate": "string", "MinCharge": "string", "UpperBand": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "ProductId": 0, "AccountProductId": 0, "CurrencyCode": 0, "ContractRateId": 0, "EffectiveDate": "string", "EndDate": "string", "BlockSize": "string", "BlockIterations": "string", "RateOrder": "string", "MainPricingPlanId": 0, "QuoteProductId": 0, "QuoteRate": "string", "SSP": "string", "RevRecContractProductId": 0, "PackageProductId": 0, "LowerBand": "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.