Contracted value grouped by billing rule

GET/api/v1/contracts/summary/by-type

Total contracted line value bucketed by billing rule (prepaid_block, flat, per_unit, recurring, usage_metered) for the value-by-type chart.

Operation ID: contract_value_by_type_api_v1_contracts_summary_by_type_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200Successful Response

Schema: SuccessEnvelope_ContractValueByTypeResponse_

successboolean
messagestring
codestring
dataContractValueByTypeResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/contracts/summary/by-type

bash

curl -X GET 'https://api.ondayzero.com/api/v1/contracts/summary/by-type' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'