Requires any of the roles: | SystemAdministrator, Manager |
GET | /billing/usage |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
# @Api(Description="Gets all usage records for specified date range")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListUsageRecords(IGet):
"""
Gets all usage records for specified date range
"""
# @ApiMember(Description="The account ID you are listing for")
account_id: Optional[str] = None
"""
The account ID you are listing for
"""
# @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
start_date: Optional[str] = None
"""
The start date to retrieve usage records for (YYYY-MM-DD)
"""
# @ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")
end_date: Optional[str] = None
"""
The end date to retrieve usage records for (YYYY-MM-DD)
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfUsageRecordInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard"> <UsageRecordInfo> <AccountSid>String</AccountSid> <Category>String</Category> <Count>0</Count> <CountUnit>String</CountUnit> <Description>String</Description> <EndDate>String</EndDate> <Price>0</Price> <PriceUnit>String</PriceUnit> <StartDate>String</StartDate> <Uri>String</Uri> <Usage>String</Usage> <UsageUnit>String</UsageUnit> </UsageRecordInfo> </ArrayOfUsageRecordInfo>