Meter Events

Record a meter event

Records a single usage event against a named meter. When the customer is on a metered plan, credits are also debited for the event (the debit is not surfaced in the response).

post/v1/sdk/meter-events

Request body

customerRefstring required
meterNamestring required
productRefstring
propertiesobject
timestampstring
valuenumber

Response

Event recorded

successboolean

Example response

{
  "success": true
}

Changes

Changed in 10 of the 27 revisions of this API.5511

    • the request property became optional

      request-property-became-optional

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the request property's maxLength was set to 20

      request-property-max-length-set

    • the request property's maxLength was set to 20

      request-property-max-length-set

    • the endpoint scheme security SecretKey was added to the API

      api-security-added

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    • added the non-success response with the status

      response-non-success-status-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new required request property

      new-required-request-property

    • removed the request property

      request-property-removed

    • removed the request property

      request-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request property

      request-property-removed

    • added the new optional request property

      new-optional-request-property

    • the request property became required

      request-property-became-required

    • the request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the request property default value 1 was removed

      request-property-default-value-removed

    This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api operation id MeterSdkController_recordEvent removed and replaced with MeterEventsSdkController_recordEvent

      api-operation-id-removed

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog