Skip to main content
POST
Record usage

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Body

application/json

A usage record posted against a metered subscription line. The line's plan must have usage_scheme=metered.

subscription_line
integer
required

Subscription line ID this usage belongs to.

date_time
string<date-time>
required

Timestamp the usage was recorded for.

quantity
number
required

Response

Usage recorded.

A usage record posted against a metered subscription line. The line's plan must have usage_scheme=metered.

subscription_line
integer
required

Subscription line ID this usage belongs to.

date_time
string<date-time>
required

Timestamp the usage was recorded for.

quantity
number
required
id
integer
read-only
creation_scheme
enum<string>
read-only
Available options:
api,
file,
panel
created
string<date-time>
read-only