Get monthly usage

GET

https://saperly.com/api/v1/usage/monthly

GET

/api/v1/usage/monthly

1 const url = 'https://saperly.com/api/v1/usage/monthly';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "monthly": [
3     {
4       "month": "2024-05",
5       "calls": 125,
6       "minutes": 3420,
7       "sms_inbound": 87,
8       "sms_outbound": 134,
9       "cost_credits": 4590
10     },
11     {
12       "month": "2024-04",
13       "calls": 98,
14       "minutes": 2750,
15       "sms_inbound": 65,
16       "sms_outbound": 120,
17       "cost_credits": 3890
18     },
19     {
20       "month": "2024-03",
21       "calls": 110,
22       "minutes": 3105,
23       "sms_inbound": 72,
24       "sms_outbound": 115,
25       "cost_credits": 4200
26     }
27   ]
28 }

Returns aggregated monthly usage stats (calls, minutes, SMS, cost).

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Query parameters

monthsintegerOptional1-12Defaults to 3

Number of months to look back (1-12)

Response

Monthly usage data

monthlylist of objects

Errors

401

Unauthorized Error

429

Too Many Requests Error