ViewBilling
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
Request Syntax
{
"End": number
,
"Marker": "string
",
"MaxItems": number
,
"Start": number
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- End
-
The end date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
Type: Timestamp
Required: No
- Marker
-
For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current Amazon Web Services account during the specified period is greater than the value that you specified for
MaxItems
, you can useMarker
to return additional billing records. Get the value ofNextPageMarker
from the previous response, and submit another request that includes the value ofNextPageMarker
in theMarker
element.Constraints: The marker must match the value of
NextPageMarker
that was returned in the previous response.Type: String
Length Constraints: Maximum length of 4096.
Required: No
- MaxItems
-
The number of billing records to be returned.
Default: 20
Type: Integer
Valid Range: Maximum value of 100.
Required: No
- Start
-
The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
Type: Timestamp
Required: No
Response Syntax
{
"BillingRecords": [
{
"BillDate": number,
"DomainName": "string",
"InvoiceId": "string",
"Operation": "string",
"Price": number
}
],
"NextPageMarker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BillingRecords
-
A summary of billing records.
Type: Array of BillingRecord objects
- NextPageMarker
-
If there are more billing records than you specified for
MaxItems
in the request, submit another request and include the value ofNextPageMarker
in the value ofMarker
.Type: String
Length Constraints: Maximum length of 4096.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.HTTP Status Code: 400
Examples
ViewBilling Example
This example illustrates one usage of ViewBilling.
Sample Request
POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205230Z
authorization:AWS4-HMAC-SHA256
Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,
SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
Signature=[calculated-signature]
x-amz-target:Route53Domains_v20140515.ViewBilling
user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"Start": 1461006299,
"End": 1463598304,
"MaxItems": 20
}
Sample Response
HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
"BillingRecords": [
{
"BillDate": 1431211111,
"DomainName": "example.net",
"InvoiceId": "1111111111",
"Operation": "REGISTER_DOMAIN",
"Price": 12
}, {
"BillDate": 1431222222,
"DomainName": "example.com",
"InvoiceId": "2222222222",
"Operation": "TRANSFER_IN_DOMAIN",
"Price": 12
}, {
"BillDate": 1431233333,
"DomainName": "example.org",
"InvoiceId": "3333333333",
"Operation": "RENEW_DOMAIN",
"Price": 12
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: