API reference (1.0)

Billing Platform API

Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/
https://my.billingplatform.com/demogm/

CONTRACT

CONTRACT API Reference

Operations

Upsert Contract

Request

Upsert Contract

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"ContractNumber"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/CONTRACT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Updated": "string",
      "Created": "string",
      "RateClassId": 0,
      "AccountId": "string",
      "Id": "string",
      "ContractNumber": "string",
      "OnEndDate": "string",
      "StartDate": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "EndDate": "string",
      "ContractStatus": "string"
    },
    "externalIDFieldName": "ContractNumber"
  }'

Responses

Response with id of updated object

Bodyapplication/json
upsertResponseArray of objects
Response
application/json
{ "upsertResponse": [ { … } ] }

Delete Contract

Request

Delete Contract

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/delete/CONTRACT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{ "retrieveResponse": { "Updated": "string", "Created": "string", "RateClassId": 0, "AccountId": "string", "Id": "string", "ContractNumber": "string", "OnEndDate": "string", "StartDate": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "EndDate": "string", "ContractStatus": "string" } }

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

PACKAGE API Reference

Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference