Listar contadores pré-pagos
RegistosGET /prepaid/meters
Returns one cursor-paginated page (limit, after) of the tenant's meters enrolled for prepaid vending, with each one's linked account, tariff, status and wallet balance. Requires the business:prepaid:read permission.
Parâmetros
statusOptional enrollment status filter: active or suspended.
um de
active,suspendedlimitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Prepaid meters in the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idmeter_idmeter_holder_nameDisplay name of the customer who holds the account the meter is installed on. Omitted when unknown.
meter_serialaccount_idaccount_numberNumber of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_nameDisplay name of the customer who holds the referenced account. Omitted when unknown.
customer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
tariff_idstatusum de
active,suspendedvending_key_refbalance_centscreated_atupdated_at
has_morenext_cursortotal_count
Permissões business:prepaid:read · Funções: admin, analyst, billing_clerk, customer_service, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/prepaid/meters" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/prepaid/meters", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/prepaid/meters",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/prepaid/meters", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "pre_2RtGgr5UObHqSN9K4rD24l9KoHf",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
"meter_holder_name": "Ana Matsinhe",
"meter_serial": "meter serial",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"tariff_id": "tar_2gW5z8815MeLds61bycBrS8bPMC",
"status": "active",
"vending_key_ref": "vending key ref",
"balance_cents": 125000,
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor",
"total_count": 125000
}