v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Events

Delete an event

Deletes a usage event by creating a new deletion event that links back to the original event. Requires valid authentication. Reach out to your account manager if you would like to participate in the Beta for the new Usage API.

delete/v1/events/{idempotencyKey}

Path parameters

idempotencyKeystring uuid required

Event key of the event that should be deleted

Response

Event deleted successfully

successboolean

Indicates if the operation was successful

messagestring

Human-readable message about the operation result

Example response

{
  "success": true,
  "message": "Event deleted successfully",
  "data": {
    "events": {
      "customerId": "550e8400-e29b-41d4-a716-446655440000",
      "eventTypeId": "550e8400-e29b-41d4-a716-446655440000",
      "datetime": "2024-01-15T10:30:00Z",
      "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000",
      "value": 1.5,
      "differentiator": "mobile",
      "invoiceSplitKey": "invoice-123",
      "parentEventId": "018c1234-5678-7abc-def0-123456789000",
      "metadata": {
        "key": "value"
      }
    }
  }
}