Deactivate Meter

POST

/api/:account_id/meters/:meter_id/deactivate

Deactivate a meter. Deactivated meters cannot be used for new prices or to record events. Existing prices linked to this meter will continue to work.

AuthorizationBearer

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

meter_idstringRequired

account_idstringRequired

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/meter_id/deactivate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "meter_987654321",
3	"account_id": "account_123456789",
4	"display_name": "Main Building Electricity Meter",
5	"event_name": "electricity_usage",
6	"aggregation_formula": "SUM(value)",
7	"event_payload_customer_mapping_key": "customer_id",
8	"event_payload_value_key": "usage_kwh",
9	"is_active": false,
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-04-20T14:45:00Z"
12	}