Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{subscription_id}
/
usage
Report Usage
curl --request POST \
  --url https://api.example.com/api/v1/subscriptions/{subscription_id}/usage \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "quantity": 1,
  "idempotency_key": "<string>",
  "description": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}
'
{
  "record": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quantity": "<string>",
    "description": "<string>",
    "idempotency_key": "<string>",
    "billed": true,
    "billed_at": "2023-11-07T05:31:56Z",
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "created": true
}

Headers

x-api-key
string
required

Path Parameters

subscription_id
string
required

Body

application/json
quantity
required
Required range: x > 0
idempotency_key
string
required
Maximum string length: 255
description
string | null
timestamp
string<date-time> | null

Response

Successful Response

record
UsageRecordResponse · object
required
created
boolean
required