POST
/
usage
/
batch
Batch create usage events
curl --request POST \
  --url https://api.paygentic.io/v0/usage/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "idempotencyKey": "<string>",
      "entitlementId": "<string>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "properties": [
        {
          "billableMetricId": "<string>",
          "quantity": 123,
          "price": "<string>"
        }
      ],
      "metadata": {}
    }
  ]
}'
{
  "object": "batchUsageEvents",
  "successful": [
    {
      "id": "<string>",
      "object": "usageEvent",
      "idempotencyKey": "<string>",
      "customerId": "<string>",
      "description": "<string>",
      "merchantId": "<string>",
      "consumerId": "<string>",
      "subscriptionId": "<string>",
      "entitlementId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "properties": [
        {
          "billableMetricId": "<string>",
          "quantity": 2,
          "price": "<string>"
        }
      ],
      "metadata": {},
      "billing": {
        "price": 123,
        "billingEventId": "<string>"
      }
    }
  ],
  "failed": [
    {
      "index": 123,
      "error": "<string>",
      "idempotencyKey": "<string>"
    }
  ],
  "summary": {
    "total": 123,
    "successful": 123,
    "failed": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
events
object[]
required

Response

Usage events created successfully

object
enum<string>
required
Available options:
batchUsageEvents
successful
object[]
required

Array of successfully created usage events

failed
object[]
required

Array of events that failed to be created with error details

summary
object
required

Summary of batch processing results