B2BROKER
B2CORE
B2CORE IB
B2TRADER
B2CONNECT
B2TRANSLATE
B2BROKERGet Bulk Operation Coverage
Counts what a selection would touch without creating anything: live IB types, non-archived trading groups, symbols and the resulting number of payment plan rows. The exact pair count runs under a short statement timeout; when it expires `planRowsExact` is `false` and `planRows` is the upper-bound estimate `userGroups × platformGroups × symbols`. The body is the `selection` object (either wrapped as `{"selection": {...}}` or sent bare).
Authorization
appToken writeApp access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.
In: header
Scope: write
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/payment-plans/bulk/coverage" \ -H "Content-Type: application/json" \ -d '{ "selection": { "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23" } }'{ "userGroups": 0, "platformGroups": 0, "symbols": 0, "planRows": 0, "planRowsExact": true, "capExceeded": true, "cap": 0}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "error": { "message": "This App is read-only and cannot perform this operation.", "code": "insufficient_scope" }}{ "error": { "message": "string", "code": "capExceeded", "details": [ { "field": "string", "issue": "string" } ] }}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}