Create Meter

POST

/api/:account_id/meters/

Create a new meter for usage-based billing.

Meters define how to track and aggregate usage events for billing. Each meter must have a unique event_name within an account.

AuthorizationBearer

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

account_idstringRequired

This endpoint expects an object.

display_namestringRequired

event_namestringRequired

aggregation_formulaenumRequired

event_payload_customer_mapping_keystringOptionalDefaults to customer_id

event_payload_value_keystringOptionalDefaults to value

Successful Response

idstring

account_idstring

display_namestring

event_namestring

aggregation_formulastring

event_payload_customer_mapping_keystring

event_payload_value_keystring

is_activeboolean

created_atdatetime

updated_atdatetime

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/meters/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"display_name": "API Request Count",
>	"event_name": "api_request",
>	"aggregation_formula": "count"
>	}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"account_id": "account_987654321",
4	"display_name": "API Request Count",
5	"event_name": "api_request",
6	"aggregation_formula": "count",
7	"event_payload_customer_mapping_key": "customer_id",
8	"event_payload_value_key": "value",
9	"is_active": true,
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z"
12	}