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
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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/ACCOUNT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACCOUNT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": 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/ACCOUNT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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/ACCOUNT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
},
"externalIDFieldName": "Name"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACCOUNT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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/ACCOUNT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ACCOUNT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": 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/ACCOUNT
https://my.billingplatform.com/demogm/rest/2.0/ACCOUNT
- 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/ACCOUNT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountTypeId": null,
"ActivityTimeZone": null,
"AllowPricingInDifferentCurrency": null,
"BillableAccountId": null,
"BillableBillingProfileId": null,
"CollectorUserId": null,
"CountryId": null,
"Created": null,
"CreatedUserId": null,
"DateDisplayFormat": null,
"Description": null,
"Id": null,
"InvoiceAtThisLevel": null,
"Name": null,
"ParentAccountId": null,
"RateHierarchy": null,
"Status": null,
"Updated": null,
"UpdatedUserId": null
},
"externalIDFieldName": "Name"
}'Response
application/json
{ "upsertResponse": [ { … } ] }