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
trueif the object exists in live mode or the valuefalseif 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"}
Create a Meter Event with asynchronous validation v2
POST / v2 / billing / meter_event_stream
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
- events array of objects Required List of meter events to include in the request. Supports up to 100 events per request.
Returns
Response attributes
No response attributes.
Error Codes
401 billing _ meter _ event _ session _ expired
The temporary session token has expired.
Response
{}