Meter Event Streams v2

You can send a higher-throughput of meter events using meter event streams. For this flow, you must first create a meter event session, which provides you with a session token. You can then create meter events through the meter event stream endpoint, using the session token for authentication. The session tokens are short-lived and you need to create a new meter event session when the token expires.

Learn more about calling API v2 endpoints.

Was this section helpful? Yes No

Create a Meter Event Stream Authentication Session

POST / v2 / billing / meter_event_session

Create a Meter Event with asynchronous validation

POST / v2 / billing / meter_event_stream

The Meter Event Session object v2

Attributes

• id string The unique ID of this auth session.
• object string, 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 _ token string The authentication token for this session. Use this token when calling the high-throughput meter event API.
• created timestamp The creation time of this session.
• expires _ at timestamp The time at which this session expires.
• livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.

The Meter Event Session object

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

Create a Meter Event Stream Authentication Session v2

POST / v2 / billing / meter_event_session

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 need to create a new meter event session when your token expires.

Learn more about calling API v2 endpoints.

Parameters

No parameters.

Returns

Returns a Meter Event Session object.

Response

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