Create a billing meter event

Changed on

Creates a billing meter event.

post/v1/billing/meter_events

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/billing/meter_events
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

event_namestring required

The name of the meter event. Corresponds with the event_name field on a meter.

expandstring[]

Specifies which fields in the response should be expanded.

identifierstring

A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. Stripe enforces uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.

payloadobject required

The payload of the event. This must contain the fields corresponding to a meter's customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload.

timestampinteger

The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

event_namestring required

The name of the meter event. Corresponds with the event_name field on a meter.

identifierstring required

A unique identifier for the event.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'billing.meter_event' required

String representing the object's type. Objects of the same type share the same value.

payloadobject required

The payload of the event. This contains the fields corresponding to a meter's customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload.

timestampinteger required

The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

  • b22313c11340Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.