Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" }, "externalIDFieldName": "Name" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" }, "externalIDFieldName": "Name" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/CONTRACT_RATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "PricingPlanId": 0, "Created": "string", "CreatedUserId": "string", "ContractId": 0, "UpdatedUserId": "string", "Id": "string", "RatingMethodId": "string", "Updated": "string", "PackageId": "string", "ProductId": 0, "Name": "string", "StartDate": "string", "EndDate": "string", "ParentContractRateId": 0, "ContractRateLabel": "string", "BulkRateStatus": "string", "PackageProductId": "string" } }