Billing Platform API
- Retrieve By Id Products
Retrieve Filtered Products
Save Products
Update Products
Upsert Products
Delete Products
Retrieve By Id Products
API Reference (1.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT/{id}
https://my.billingplatform.com/demogm/rest/2.0/PRODUCT/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
Response
application/json
{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PRODUCT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
Response
application/json
{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT
https://my.billingplatform.com/demogm/rest/2.0/PRODUCT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PRODUCT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Status": "string",
"ContractRequiredFlag": 0,
"OverridePermissions": "string",
"CustomizeTaxRules": 0,
"Id": "string",
"UpdatedUserId": "string",
"RestrictUseOfUnreferencedContracts": 0,
"Name": "string",
"Created": "string",
"CreatedUserId": "string",
"OrderOfExecution": "string",
"Updated": "string",
"RatingMethodId": "string",
"UseFormulaSSP": 0,
"SSPFormula": "string",
"Rate": "string",
"SfLastSync": "string",
"SfStatusError": "string",
"DefaultRateFlag": 0,
"ExternalKey": "string",
"SfSyncBatchId": "string",
"SfRecordId": "string"
}
}'
Response
application/json
{ "retrieveResponse": { "Status": "string", "ContractRequiredFlag": 0, "OverridePermissions": "string", "CustomizeTaxRules": 0, "Id": "string", "UpdatedUserId": "string", "RestrictUseOfUnreferencedContracts": 0, "Name": "string", "Created": "string", "CreatedUserId": "string", "OrderOfExecution": "string", "Updated": "string", "RatingMethodId": "string", "UseFormulaSSP": 0, "SSPFormula": "string", "Rate": "string", "SfLastSync": "string", "SfStatusError": "string", "DefaultRateFlag": 0, "ExternalKey": "string", "SfSyncBatchId": "string", "SfRecordId": "string" } }