Skip to main content
POST
Create a usage record
Records usage against a subscription created with a cappedAmount. Usage is billed at the end of the period. See Usage-based charges.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side, never send a shop id.

Path Parameters

id
string
required

The subscription id.

Body

application/json
description
string
required

What was used, for example 120 SMS sent.

Maximum string length: 200
amount
number
required

In the subscription currency, two decimals at most.

idempotencyKey
string
required
Maximum string length: 120

Response

A record with this idempotencyKey already exists; it is returned.