POST
/
usage
/
batch
curl --request POST \
  --url https://api.sulu.sh/v0/usage/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "idempotencyKey": "<string>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "properties": [
        {
          "billableMetricId": "<string>",
          "quantity": 123,
          "price": "<string>"
        }
      ],
      "metadata": {}
    }
  ]
}'
[
  {
    "id": "<string>",
    "object": "usageEvent",
    "idempotencyKey": "<string>",
    "customerId": "<string>",
    "description": "<string>",
    "merchantId": "<string>",
    "consumerId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "properties": [
      {
        "billableMetricId": "<string>",
        "quantity": 123,
        "price": "<string>"
      }
    ],
    "metadata": {},
    "billing": {
      "price": 123,
      "billingEventId": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
events
object[]
required

Response

201
application/json
Usage events created successfully
​
id
string

Unique identifier for a usage event

​
object
enum<string>
Available options:
usageEvent
​
idempotencyKey
string
​
customerId
string
​
description
string
​
merchantId
string
​
consumerId
string
​
timestamp
string
​
createdAt
string
​
properties
object[]
​
metadata
object
​
billing
object

Billing information for the usage event when it has been billed.