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 will provide 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 will need to create a new meter event session when the token expires.
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
trueif the object exists in live mode or the valuefalseif 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 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
trueif the object exists in live mode or the valuefalseif 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.
{}