Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.
Learn more about calling API v2 endpoints.Parameters
No parameters.
Returns
Response attributes
- idstring
The unique id of this auth session.
- objectstring, value is "v2.billing.meter_event_session"
String representing the object’s type. Objects of the same type share the same value of the object field.
- authentication_
tokenstring The authentication token for this session. Use this token when calling the high-throughput meter event API.
- createdtimestamp
The creation time of this session.
- expires_
attimestamp The time at which this session will expire.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode.
{ "id": "<AUTH_SESSION_ID>", "livemode": "false", "object": "v2.billing.meter_event_session", "authentication_token": "token_12345678", "created": "2024-06-01T12:00:00.000Z", "expires_at": "2024-06-01T12:15:00.000Z"}
Creates meter events. Events are processed asynchronously, including validation. Requires a meter event session for authentication. Supports up to 10,000 requests per second in livemode. For even higher rate-limits, contact sales.
Learn more about calling API v2 endpoints.Parameters
- eventsarray of objectsRequired
List of meter events to include in the request. Supports up to 100 events per request.
Returns
Response attributes
No response attributes.
The temporary session token has expired.
{}
A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.
Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
A credit grant is an API resource that documents the allocation of some billing credits to a customer.
Related guide: Billing credits
Indicates the billing credit balance for billing credits granted to a customer.