Skip to main content
POST
/
usage
Set Usage
curl --request POST \
  --url https://api.useautumn.com/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "<string>",
  "feature_id": "<string>",
  "value": 123,
  "entity_id": "<string>",
  "customer_data": {
    "name": "<string>",
    "email": "<string>"
  }
}'
{
  "success": true
}

Authorizations

Authorization
string
header
required

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

Body

application/json
customer_id
string
required

The ID of the customer.

feature_id
string
required

The ID of the feature to set usage for.

value
number
required

The value you want to set this customer's usage of the feature to.

entity_id
string

The ID of the entity to set usage for.

customer_data
object

Used to add customer details like name or email when auto-creating a customer.

Response

200 - application/json
success
boolean
required