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/ACTIVITY/{id}
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AccountPackageId": null, "AccountProductId": null, "AccumulatorValueId": null, "ActivityCollectorId": null, "ActivityDate": null, "AvalaraGroupKey": null, "BillingIdentifierAccountProductId": null, "BillingIdentifierId": null, "CollectorStageId": null, "ContractId": null, "ContractRateId": null, "CostUnrounded": null, "CountryCodeMapId": null, "Created": null, "CreatedUserId": null, "CurrencyCode": null, "DestinationCountryCodeId": null, "DiscountActivityId": null, "DiscountedBy": null, "EffectiveRated": null, "Estimated": null, "EventInvoiceCycleId": null, "ExchangeRateId": null, "Feature": null, "Formula": null, "Id": null, "InvoiceId": null, "MDLEventId": null, "ManualChargeByUserId": null, "MinChargeFlag": null, "OriginationCountryCodeId": null, "PackageProductId": null, "PricingCurrencyCode": null, "PricingId": null, "ProcessDescription": null, "ProcessStatus": null, "ProductId": null, "ProrateFactor": null, "Quantity": null, "RateClassProductId": null, "RateDate": null, "RateSource": null, "RatedAmount": null, "RatingDate": null, "RatingMethodId": null, "ReprocessQueueID": null, "SplitFromBillActId": null, "StandardCostUnrounded": null, "SubscriptionFromDate": null, "SubscriptionToDate": null, "TaxCostUnrounded": null, "TieredGroup": null, "UpdateError": null, "Updated": null, "UpdatedUserId": null, "UpperBand": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AccountPackageId": null, "AccountProductId": null, "AccumulatorValueId": null, "ActivityCollectorId": null, "ActivityDate": null, "AvalaraGroupKey": null, "BillingIdentifierAccountProductId": null, "BillingIdentifierId": null, "CollectorStageId": null, "ContractId": null, "ContractRateId": null, "CostUnrounded": null, "CountryCodeMapId": null, "Created": null, "CreatedUserId": null, "CurrencyCode": null, "DestinationCountryCodeId": null, "DiscountActivityId": null, "DiscountedBy": null, "EffectiveRated": null, "Estimated": null, "EventInvoiceCycleId": null, "ExchangeRateId": null, "Feature": null, "Formula": null, "Id": null, "InvoiceId": null, "MDLEventId": null, "ManualChargeByUserId": null, "MinChargeFlag": null, "OriginationCountryCodeId": null, "PackageProductId": null, "PricingCurrencyCode": null, "PricingId": null, "ProcessDescription": null, "ProcessStatus": null, "ProductId": null, "ProrateFactor": null, "Quantity": null, "RateClassProductId": null, "RateDate": null, "RateSource": null, "RatedAmount": null, "RatingDate": null, "RatingMethodId": null, "ReprocessQueueID": null, "SplitFromBillActId": null, "StandardCostUnrounded": null, "SubscriptionFromDate": null, "SubscriptionToDate": null, "TaxCostUnrounded": null, "TieredGroup": null, "UpdateError": null, "Updated": null, "UpdatedUserId": null, "UpperBand": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AccountPackageId": null,
"AccountProductId": null,
"AccumulatorValueId": null,
"ActivityCollectorId": null,
"ActivityDate": null,
"AvalaraGroupKey": null,
"BillingIdentifierAccountProductId": null,
"BillingIdentifierId": null,
"CollectorStageId": null,
"ContractId": null,
"ContractRateId": null,
"CostUnrounded": null,
"CountryCodeMapId": null,
"Created": null,
"CreatedUserId": null,
"CurrencyCode": null,
"DestinationCountryCodeId": null,
"DiscountActivityId": null,
"DiscountedBy": null,
"EffectiveRated": null,
"Estimated": null,
"EventInvoiceCycleId": null,
"ExchangeRateId": null,
"Feature": null,
"Formula": null,
"Id": null,
"InvoiceId": null,
"MDLEventId": null,
"ManualChargeByUserId": null,
"MinChargeFlag": null,
"OriginationCountryCodeId": null,
"PackageProductId": null,
"PricingCurrencyCode": null,
"PricingId": null,
"ProcessDescription": null,
"ProcessStatus": null,
"ProductId": null,
"ProrateFactor": null,
"Quantity": null,
"RateClassProductId": null,
"RateDate": null,
"RateSource": null,
"RatedAmount": null,
"RatingDate": null,
"RatingMethodId": null,
"ReprocessQueueID": null,
"SplitFromBillActId": null,
"StandardCostUnrounded": null,
"SubscriptionFromDate": null,
"SubscriptionToDate": null,
"TaxCostUnrounded": null,
"TieredGroup": null,
"UpdateError": null,
"Updated": null,
"UpdatedUserId": null,
"UpperBand": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY/{id}
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AccountPackageId": null, "AccountProductId": null, "AccumulatorValueId": null, "ActivityCollectorId": null, "ActivityDate": null, "AvalaraGroupKey": null, "BillingIdentifierAccountProductId": null, "BillingIdentifierId": null, "CollectorStageId": null, "ContractId": null, "ContractRateId": null, "CostUnrounded": null, "CountryCodeMapId": null, "Created": null, "CreatedUserId": null, "CurrencyCode": null, "DestinationCountryCodeId": null, "DiscountActivityId": null, "DiscountedBy": null, "EffectiveRated": null, "Estimated": null, "EventInvoiceCycleId": null, "ExchangeRateId": null, "Feature": null, "Formula": null, "Id": null, "InvoiceId": null, "MDLEventId": null, "ManualChargeByUserId": null, "MinChargeFlag": null, "OriginationCountryCodeId": null, "PackageProductId": null, "PricingCurrencyCode": null, "PricingId": null, "ProcessDescription": null, "ProcessStatus": null, "ProductId": null, "ProrateFactor": null, "Quantity": null, "RateClassProductId": null, "RateDate": null, "RateSource": null, "RatedAmount": null, "RatingDate": null, "RatingMethodId": null, "ReprocessQueueID": null, "SplitFromBillActId": null, "StandardCostUnrounded": null, "SubscriptionFromDate": null, "SubscriptionToDate": null, "TaxCostUnrounded": null, "TieredGroup": null, "UpdateError": null, "Updated": null, "UpdatedUserId": null, "UpperBand": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountId": null, "AccountPackageId": null, "AccountProductId": null, "AccumulatorValueId": null, "ActivityCollectorId": null, "ActivityDate": null, "AvalaraGroupKey": null, "BillingIdentifierAccountProductId": null, "BillingIdentifierId": null, "CollectorStageId": null, "ContractId": null, "ContractRateId": null, "CostUnrounded": null, "CountryCodeMapId": null, "Created": null, "CreatedUserId": null, "CurrencyCode": null, "DestinationCountryCodeId": null, "DiscountActivityId": null, "DiscountedBy": null, "EffectiveRated": null, "Estimated": null, "EventInvoiceCycleId": null, "ExchangeRateId": null, "Feature": null, "Formula": null, "Id": null, "InvoiceId": null, "MDLEventId": null, "ManualChargeByUserId": null, "MinChargeFlag": null, "OriginationCountryCodeId": null, "PackageProductId": null, "PricingCurrencyCode": null, "PricingId": null, "ProcessDescription": null, "ProcessStatus": null, "ProductId": null, "ProrateFactor": null, "Quantity": null, "RateClassProductId": null, "RateDate": null, "RateSource": null, "RatedAmount": null, "RatingDate": null, "RatingMethodId": null, "ReprocessQueueID": null, "SplitFromBillActId": null, "StandardCostUnrounded": null, "SubscriptionFromDate": null, "SubscriptionToDate": null, "TaxCostUnrounded": null, "TieredGroup": null, "UpdateError": null, "Updated": null, "UpdatedUserId": null, "UpperBand": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY
https://my.billingplatform.com/demogm/rest/2.0/ACTIVITY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACTIVITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AccountPackageId": null,
"AccountProductId": null,
"AccumulatorValueId": null,
"ActivityCollectorId": null,
"ActivityDate": null,
"AvalaraGroupKey": null,
"BillingIdentifierAccountProductId": null,
"BillingIdentifierId": null,
"CollectorStageId": null,
"ContractId": null,
"ContractRateId": null,
"CostUnrounded": null,
"CountryCodeMapId": null,
"Created": null,
"CreatedUserId": null,
"CurrencyCode": null,
"DestinationCountryCodeId": null,
"DiscountActivityId": null,
"DiscountedBy": null,
"EffectiveRated": null,
"Estimated": null,
"EventInvoiceCycleId": null,
"ExchangeRateId": null,
"Feature": null,
"Formula": null,
"Id": null,
"InvoiceId": null,
"MDLEventId": null,
"ManualChargeByUserId": null,
"MinChargeFlag": null,
"OriginationCountryCodeId": null,
"PackageProductId": null,
"PricingCurrencyCode": null,
"PricingId": null,
"ProcessDescription": null,
"ProcessStatus": null,
"ProductId": null,
"ProrateFactor": null,
"Quantity": null,
"RateClassProductId": null,
"RateDate": null,
"RateSource": null,
"RatedAmount": null,
"RatingDate": null,
"RatingMethodId": null,
"ReprocessQueueID": null,
"SplitFromBillActId": null,
"StandardCostUnrounded": null,
"SubscriptionFromDate": null,
"SubscriptionToDate": null,
"TaxCostUnrounded": null,
"TieredGroup": null,
"UpdateError": null,
"Updated": null,
"UpdatedUserId": null,
"UpperBand": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }