| Requires any of the roles: | SystemAdministrator, Manager |
| GET | /billing/usage |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
/** @description Gets all usage records for specified date range */
// @Api(Description="Gets all usage records for specified date range")
class ListUsageRecords implements IGet, JsonSerializable
{
public function __construct(
/** @description The account ID you are listing for */
// @ApiMember(Description="The account ID you are listing for")
/** @var string|null */
public ?string $accountId=null,
/** @description The start date to retrieve usage records for (YYYY-MM-DD) */
// @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
/** @var string|null */
public ?string $startDate=null,
/** @description The end date to retrieve usage records for (YYYY-MM-DD) */
// @ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")
/** @var string|null */
public ?string $endDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['accountId'])) $this->accountId = $o['accountId'];
if (isset($o['startDate'])) $this->startDate = $o['startDate'];
if (isset($o['endDate'])) $this->endDate = $o['endDate'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->accountId)) $o['accountId'] = $this->accountId;
if (isset($this->startDate)) $o['startDate'] = $this->startDate;
if (isset($this->endDate)) $o['endDate'] = $this->endDate;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /billing/usage HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
accountSid: String,
category: String,
count: 0,
countUnit: String,
description: String,
endDate: String,
price: 0,
priceUnit: String,
startDate: String,
usage: String,
usageUnit: String,
uri: String
}
]