API Reference

Pricing Metrics

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Pricing Metric Summary

client.PricingMetrics.NewSummary(ctx, pricingMetricID, body) (*PricingMetricNewSummaryResponse, error)

post/pricing-metrics/{pricing_metric_id}/summary

Create Pricing Metric Summary

ParametersExpand Collapse

pricingMetricID string

body PricingMetricNewSummaryParams

Period param.Field[Period]

The period that the summary should be computed over.

SubjectID param.Field[string]

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

ReturnsExpand Collapse

type PricingMetricNewSummaryResponse struct{…}

ID string

The ID of the pricing metric summary.

Period Period

The period that the summary is computed over.

End Time

formatdate-time

Start Time

formatdate-time

InclusiveEnd booloptional

InclusiveStart booloptional

PricingMetricID string

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

SubjectID string

The ID of the subject that the summary is for.

Value string

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

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"
  "time"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := lark.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.PricingMetrics.NewSummary(
    context.TODO(),
    "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
    lark.PricingMetricNewSummaryParams{
      Period: lark.PeriodParam{
        Start: time.Now(),
        End: time.Now(),
      },
      SubjectID: "subj_VyX6Q96h5avMho8O7QWlKeXE",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

200 example

{
  "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

200 example

{
  "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"
}