Billing Platform API
API Reference (1.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/COUNTRY
https://my.billingplatform.com/demogm/rest/2.0/COUNTRY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/COUNTRY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"UpdatedUserId": "string",
"Alpha2_Code": "string",
"Code": "string",
"CountryName": "string",
"Created": "string",
"CreatedUserId": "string",
"Id": "string"
},
"externalIDFieldName": "Code"
}'
Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/COUNTRY
https://my.billingplatform.com/demogm/rest/2.0/delete/COUNTRY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/COUNTRY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
Response
application/json
{ "retrieveResponse": { "Updated": "string", "UpdatedUserId": "string", "Alpha2_Code": "string", "Code": "string", "CountryName": "string", "Created": "string", "CreatedUserId": "string", "Id": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/COUNTRY
https://my.billingplatform.com/demogm/rest/2.0/COUNTRY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/COUNTRY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"UpdatedUserId": "string",
"Alpha2_Code": "string",
"Code": "string",
"CountryName": "string",
"Created": "string",
"CreatedUserId": "string",
"Id": "string"
},
"externalIDFieldName": "Code"
}'
Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/COUNTRY
https://my.billingplatform.com/demogm/rest/2.0/delete/COUNTRY
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/COUNTRY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
Response
application/json
{ "retrieveResponse": { "Updated": "string", "UpdatedUserId": "string", "Alpha2_Code": "string", "Code": "string", "CountryName": "string", "Created": "string", "CreatedUserId": "string", "Id": "string" } }