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/ACCOUNT_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT_PRODUCT
- 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/ACCOUNT_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AccountPackageId": null,
"BillingCycleStartDate": null,
"ContractId": null,
"ContractModificationDate": null,
"ContractModificationMethod": null,
"CreateNewRevRecContract": null,
"Created": null,
"CreatedUserId": null,
"DiscountVoucherBalance": null,
"EditModifyContract": null,
"EndDate": null,
"Id": null,
"Name": null,
"OrderId": null,
"PackageProductId": null,
"ParentCustomerProductId": null,
"ProductId": null,
"Quantity": null,
"QuoteId": null,
"QuoteProductId": null,
"RateOverride": null,
"RatingMethodId": null,
"RenewalDate": null,
"RenewalStartDate": null,
"RevRecContractId": null,
"RevRecFieldsToUpdate": null,
"SfLastSync": null,
"SfRecordId": null,
"SfStatusError": null,
"SfSyncBatchId": null,
"StartDate": null,
"Status": null,
"TrialEndDate": null,
"UpdateRevRecContractProduct": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACCOUNT_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/delete/ACCOUNT_PRODUCT
- 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/ACCOUNT_PRODUCT \
-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/ACCOUNT_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT_PRODUCT
- 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/ACCOUNT_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AccountPackageId": null,
"BillingCycleStartDate": null,
"ContractId": null,
"ContractModificationDate": null,
"ContractModificationMethod": null,
"CreateNewRevRecContract": null,
"Created": null,
"CreatedUserId": null,
"DiscountVoucherBalance": null,
"EditModifyContract": null,
"EndDate": null,
"Id": null,
"Name": null,
"OrderId": null,
"PackageProductId": null,
"ParentCustomerProductId": null,
"ProductId": null,
"Quantity": null,
"QuoteId": null,
"QuoteProductId": null,
"RateOverride": null,
"RatingMethodId": null,
"RenewalDate": null,
"RenewalStartDate": null,
"RevRecContractId": null,
"RevRecFieldsToUpdate": null,
"SfLastSync": null,
"SfRecordId": null,
"SfStatusError": null,
"SfSyncBatchId": null,
"StartDate": null,
"Status": null,
"TrialEndDate": null,
"UpdateRevRecContractProduct": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/ACCOUNT_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/delete/ACCOUNT_PRODUCT
- 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/ACCOUNT_PRODUCT \
-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": [ { … } ] }