API Reference (1.0)
Billing Platform API
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/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PACKAGE_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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AllowPriceOverride": null,
"Created": null,
"CreatedUserId": null,
"Id": null,
"LinkPackageId": null,
"LinkPackageProductId": null,
"MaxQty": null,
"MinQty": null,
"Name": null,
"PackageId": null,
"ParentComponentLabel": null,
"ParentPackageProductId": null,
"ProductId": null,
"Rate": null,
"RateOverride": null,
"RatingMethodId": null,
"Updated": null,
"UpdatedUserId": null
}
}'
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PACKAGE_PRODUCT
- 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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AllowPriceOverride": null,
"Created": null,
"CreatedUserId": null,
"Id": null,
"LinkPackageId": null,
"LinkPackageProductId": null,
"MaxQty": null,
"MinQty": null,
"Name": null,
"PackageId": null,
"ParentComponentLabel": null,
"ParentPackageProductId": null,
"ProductId": null,
"Rate": null,
"RateOverride": null,
"RatingMethodId": null,
"Updated": null,
"UpdatedUserId": null
},
"externalIDFieldName": "Name"
}'
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/delete/PACKAGE_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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PACKAGE_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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AllowPriceOverride": null,
"Created": null,
"CreatedUserId": null,
"Id": null,
"LinkPackageId": null,
"LinkPackageProductId": null,
"MaxQty": null,
"MinQty": null,
"Name": null,
"PackageId": null,
"ParentComponentLabel": null,
"ParentPackageProductId": null,
"ProductId": null,
"Rate": null,
"RateOverride": null,
"RatingMethodId": null,
"Updated": null,
"UpdatedUserId": null
}
}'
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PACKAGE_PRODUCT
- 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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AllowPriceOverride": null,
"Created": null,
"CreatedUserId": null,
"Id": null,
"LinkPackageId": null,
"LinkPackageProductId": null,
"MaxQty": null,
"MinQty": null,
"Name": null,
"PackageId": null,
"ParentComponentLabel": null,
"ParentPackageProductId": null,
"ProductId": null,
"Rate": null,
"RateOverride": null,
"RatingMethodId": null,
"Updated": null,
"UpdatedUserId": null
},
"externalIDFieldName": "Name"
}'
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PACKAGE_PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/delete/PACKAGE_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/PACKAGE_PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
{ "updateResponse": [ { … } ] }