# CustomerUsageDataJsonSchema

## object

### supplemental

- **object** [SupplementalData](https://docs.mediakind.com/api-reference/management-api/schemas/supplementaldata) **Required**  
  Metadata pertaining to the query.

#### Properties

- **download** boolean **Required**  
  Whether browser was indicated to download file

- **end** string **Required** format: date  
  The end date of the query.

- **filters** object [SupplementalFiltersData](https://docs.mediakind.com/api-reference/management-api/schemas/supplementalfiltersdata) **Required**  
  The filters applied to the query.

#### Properties

- **meterNames** list of strings **Required**  
  Meter names the results were filtered to.

- **paymentMethodIds** list of strings **Required**  
  Payment method IDs the results were filtered to.

- **projectNames** list of strings **Required**  
  Project names the results were filtered to.

- **format** string **Required**  
  The output format. Either csv or json.

- **granularity** string **Required**  
  The time bucket used for aggregation.

- **groupBy** list of strings **Required**  
  The list of fields that the results are grouped by.

- **records** integer **Required**  
  The number of result records returned.

- **start** string **Required** format: date  
  The start date of the query.

- **value** list of objects [MeterData](https://docs.mediakind.com/api-reference/management-api/schemas/meterdata) **Required**  
  The usage data per day per meter

#### Properties

- **cost** string **Required**  
  Monetary value of usage for this record, in the currency specified by the currency field. How this is charged depends on the entitlement type: for a license entitlement the amount is fully covered and nothing is billed; for cash, quantity, or pre-commitment entitlements this amount is deducted from the entitlement balance; with no entitlement the amount is billed directly.

- **currency** string **Required**  
  The currency of the cost field.

- **date** string **Required** format: date-time  
  The date and time of this usage record. Truncated to the granularity of the query (e.g. if granularity is 'day' then time will be 00:00:00).

- **dateProcessed** string or null **Optional** format: date-time  
  The report_time truncated to the requested granularity. Null for usage that has not yet been charged. Comparing against date (sample_time) reveals late-reported data.

- **entitlement** string or null **Optional** format: uuid  
  The ID of the entitlement applied to this usage. Can be joined against the /entitlements endpoint.

- **entitlementType** string or null **Optional**  
  The type of entitlement applied to this usage, if any.

- **family** string **Optional**  
  Product family this meter belongs to.

- **meterName** string **Required**  
  The meter name.

- **meterSku** string or null **Optional**  
  The SaaS SKU identifier for this meter.

- **paymentMethod** string **Optional** format: uuid  
  The ID of the payment method associated with this usage.

- **paymentMethodName** string or null **Optional**  
  The display name of the payment method associated with this usage.

- **price** double **Optional**  
  Per-unit price for this record (cost / quantity).

- **project** string **Optional**  
  The name of the project this usage belongs to.

- **quantity** double **Required**  
  Total units accrued for this record.

- **solution** string **Optional**  
  Solution within the product family this meter belongs to.

- **unit** string or null **Optional**  
  The unit that this meter is reported in, e.g. 'gigabytes' or 'minutes.'