Sign in
Billing Meter Usage

Create meter usage record

Changed on

Create a new meter usage record

<div> <code>create:meter_usage</code> </div>
post/api/v1/billing/meter_usage

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/billing/meter_usage
  • Auth: HTTP bearer

Request body

customer_agreement_idstring required

The billing agreement against which to record usage

billing_feature_codestring required

The code of the feature within the agreement against which to record usage

meter_valuestring required

The value of usage to record

meter_usage_timestampstring date-time

The date and time the usage needs to be recorded for (defaults to current date/time)

meter_type_code'absolute' | 'delta'

Absolutes overrides the current usage

Example request

{
  "customer_agreement_id": "agreement_0195ac80a14c2ca2cec97d026d864de0",
  "billing_feature_code": "pro_gym",
  "meter_value": "pro_gym",
  "meter_usage_timestamp": "2024-11-18T13:32:03+11"
}

Response

Meter usage record successfully created.

messagestring

Response message.

codestring

Response code.

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes