Billing Platform API
API Reference (1.0)
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/STATEMENT_TEMPLATE
https://my.billingplatform.com/demogm/rest/2.0/STATEMENT_TEMPLATE
- 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/STATEMENT_TEMPLATE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"StatementTemplateName": "string",
"AccountId": "string",
"Status": "string",
"LogoFilePath": "string",
"SupportMessage": "string",
"DefaultFlag": 0,
"SystemLogoFileName": "string",
"ShowTaxFeeDetail": 0,
"ShowCreditAdjDetail": 0,
"ShowAging": 0,
"Type": "string",
"ShowPastDueStatements": 0,
"SupportMessage1": "string",
"EbppUrl": "string",
"LanguageCode": "string",
"DateFormat": "string",
"Created": "string",
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"BaseEntityId": "string",
"PreviewXsd": "string",
"Id": "string",
"SupportNumber": "string",
"StatementXslId": "string",
"FileStorageId": "string",
"EmailTemplateId": "string"
},
"externalIDFieldName": "StatementTemplateName"
}'
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/STATEMENT_TEMPLATE
https://my.billingplatform.com/demogm/rest/2.0/delete/STATEMENT_TEMPLATE
- 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/STATEMENT_TEMPLATE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
{ "retrieveResponse": { "StatementTemplateName": "string", "AccountId": "string", "Status": "string", "LogoFilePath": "string", "SupportMessage": "string", "DefaultFlag": 0, "SystemLogoFileName": "string", "ShowTaxFeeDetail": 0, "ShowCreditAdjDetail": 0, "ShowAging": 0, "Type": "string", "ShowPastDueStatements": 0, "SupportMessage1": "string", "EbppUrl": "string", "LanguageCode": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string", "PreviewXsd": "string", "Id": "string", "SupportNumber": "string", "StatementXslId": "string", "FileStorageId": "string", "EmailTemplateId": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/STATEMENT_TEMPLATE
https://my.billingplatform.com/demogm/rest/2.0/STATEMENT_TEMPLATE
- 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/STATEMENT_TEMPLATE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"StatementTemplateName": "string",
"AccountId": "string",
"Status": "string",
"LogoFilePath": "string",
"SupportMessage": "string",
"DefaultFlag": 0,
"SystemLogoFileName": "string",
"ShowTaxFeeDetail": 0,
"ShowCreditAdjDetail": 0,
"ShowAging": 0,
"Type": "string",
"ShowPastDueStatements": 0,
"SupportMessage1": "string",
"EbppUrl": "string",
"LanguageCode": "string",
"DateFormat": "string",
"Created": "string",
"Updated": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"BaseEntityId": "string",
"PreviewXsd": "string",
"Id": "string",
"SupportNumber": "string",
"StatementXslId": "string",
"FileStorageId": "string",
"EmailTemplateId": "string"
},
"externalIDFieldName": "StatementTemplateName"
}'
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/STATEMENT_TEMPLATE
https://my.billingplatform.com/demogm/rest/2.0/delete/STATEMENT_TEMPLATE
- 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/STATEMENT_TEMPLATE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'
{ "retrieveResponse": { "StatementTemplateName": "string", "AccountId": "string", "Status": "string", "LogoFilePath": "string", "SupportMessage": "string", "DefaultFlag": 0, "SystemLogoFileName": "string", "ShowTaxFeeDetail": 0, "ShowCreditAdjDetail": 0, "ShowAging": 0, "Type": "string", "ShowPastDueStatements": 0, "SupportMessage1": "string", "EbppUrl": "string", "LanguageCode": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string", "PreviewXsd": "string", "Id": "string", "SupportNumber": "string", "StatementXslId": "string", "FileStorageId": "string", "EmailTemplateId": "string" } }