Querying Monthly Bills
Function
You can query your monthly bills that cover amount due, expenditures, refunds, and adjustments.
For details about how to query monthly bills in the Partner Center, click here.
The partner bill for each month is generated before 12:00 (Beijing Time) on the fifth day of the next month.
Constraints
This API can be invoked only by the partner account AK/SK or token.
Debugging
You can debug the API in API Explorer which supports automatic authentication.API Explorer can automatically generate and debug example SDK code.
URI
GET /v2/bills/partner-bills/postpaid-bill-summary
The following table describes the parameters.
Parameter |
Mandatory |
Type |
Value Range |
Description |
---|---|---|---|---|
bill_cycle |
Yes |
String |
A maximum of 10 characters |
Month when a bill is generated. Format: YYYY-MM |
Request
Request parameters
None
Example Request
GET https://bss-intl.myhuaweicloud.com/v2/bills/partner-bills/postpaid-bill-summary?bill_cycle=2020-12 HTTP/1.1 Content-Type: application/json X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
Response
Response parameters
Parameter |
Type |
Value Range |
Description |
---|---|---|---|
error_code |
String |
A maximum of 16 characters |
Error code. For details, see Returned Values. This parameter is returned only when a failure occurs. |
error_msg |
String |
A maximum of 1024 characters |
Error description. This parameter is returned only when a failure occurs. |
bill_cycle |
String |
A maximum of 10 characters |
Month when a bill is generated. This parameter is returned only when the query is successful. Format: YYYY-MM |
initial_amount_due |
BigDecimal |
- |
Amount due (tax included) in a bill. Amount due (output tax included) = Expenditures + Refunds + Adjustments |
consume_amount |
BigDecimal |
- |
Expenditures in a bill. |
refunds |
BigDecimal |
- |
Refunds in a bill. |
adjustments |
BigDecimal |
- |
Partner's adjustments in a billing cycle, for example, arrears write-offs. |
tax_amount |
BigDecimal |
- |
Output tax in a bill, which is not included in the amount due. |
currency |
String |
A maximum of 8 characters |
This parameter is returned only when the query is successful. USD |
Example Response
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "bill_cycle": "2020-12", "initial_amount_due": 90, "consume_amount": 140, "refunds": -30, "adjustments": -20, "tax_amount": 10, "currency": "USD" }
Returned Values
- 4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
- 5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.
HTTP Value |
Error Code |
Description |
---|---|---|
400 |
CBC.0100 |
Invalid parameter |
403 |
CBC.0151 |
Access denied. |
500 |
CBC.0999 |
Other errors |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot