Create Pricing Metric Summary

client.pricingMetrics.createSummary(, , ?): PricingMetricCreateSummaryResponse { id, period, pricing_metric_id, 2 more }

post/pricing-metrics/{pricing_metric_id}/summary

ParametersExpand Collapse

pricingMetricID: string

body: PricingMetricCreateSummaryParams { period, subject_id }

period: Period { end, start, inclusive_end, inclusive_start }

The period that the summary should be computed over.

end: string

formatdate-time

start: string

formatdate-time

inclusive_end?: boolean

inclusive_start?: boolean

subject_id: string

The ID or external ID of the subject that the summary should be computed for.

ReturnsExpand Collapse

PricingMetricCreateSummaryResponse { id, period, pricing_metric_id, 2 more }

id: string

The ID of the pricing metric summary.

period: Period { end, start, inclusive_end, inclusive_start }

The period that the summary is computed over.

end: string

formatdate-time

start: string

formatdate-time

inclusive_end?: boolean

inclusive_start?: boolean

pricing_metric_id: string

The ID of the pricing metric that the summary is for.

subject_id: string

The ID of the subject that the summary is for.

value: string | null

The computed value of the pricing metric for the period. If the pricing metric does not have any usage events for the period, this will be null.

Create Pricing Metric Summary

import Lark from 'lark-billing';

const client = new Lark({
  apiKey: 'My API Key',
});

const response = await client.pricingMetrics.createSummary('pmtr_GlX5Tcm2HOn00CoRTFxw2Amw', {
  period: { start: '2025-10-01T00:00:00Z', end: '2025-11-01T00:00:00Z' },
  subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
});

console.log(response.id);

{
  "id": "pmtr_sum_vqXWIKBYia15D5dNyCLLlsa4",
  "period": {
    "end": "2025-11-01T00:00:00Z",
    "start": "2025-10-01T00:00:00Z",
    "inclusive_end": false,
    "inclusive_start": true
  },
  "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
  "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
  "value": "22.5"
}

Returns Examples

{
  "id": "pmtr_sum_vqXWIKBYia15D5dNyCLLlsa4",
  "period": {
    "end": "2025-11-01T00:00:00Z",
    "start": "2025-10-01T00:00:00Z",
    "inclusive_end": false,
    "inclusive_start": true
  },
  "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
  "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
  "value": "22.5"
}