Get Order Amount - GetOrderAmount

Overview

Query order amount summary and count statistics under specified conditions

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetOrderAmount`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
StartTime	int	Query start time (Unix timestamp, seconds). Must be provided together with `EndTime`.Maximum range: 366 days	Yes
EndTime	int	Query end time (Unix timestamp, seconds). Must be provided together with `StartTime`	Yes
ResourceIds.N	string	Resource ID list (optional)	No
ModelIds.N	string	Model ID list (optional)	No
PricingUnits.N	int	Pricing unit list (optional)	No
PricingSkus.N	string	Billing unit SKU list (optional)	No
ProductCodes.N	string	Product code list (optional). Enum: `modelverse`, `sandbox`	No
OrderTypes.N	int	Order type list (optional)	No
Regions.N	string	Region list (optional). See Region and Zone List	No
OrganizationIds.N	string	Organization ID list (optional)	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
TotalOrderAmount	string	Total amount of all orders	Yes
PaidAmount	string	Paid amount	No
UnpaidAmount	string	Unpaid (overdue) amount	No
CashAmount	string	Total cash account deduction	No
BonusAmount	string	Total bonus account deduction amount	No
CouponAmount	string	Total coupon deduction amount	No
StarCardAmount	string	Total Star Card deduction amount	No
OrderCount	int	Total order count	No
PaidCount	int	Paid order count	No
UnpaidCount	int	Unpaid order count	No

Example

Request Example


https://api.surfercloud.com/?Action=GetOrderAmount
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=xBjqWlgq
&ResourceIds.N=YUhHIvbF
&ModelIds.N=YLZoVxpX
&PricingUnits.N=4
&OrderTypes.N=6
&StartTime=2
&EndTime=7
&PricingSkus.N=ZvSMEZfo
&ProductCodes.N=GQiNWIED
&Regions.N=dOnMCcfY
&OrganizationIds.N=HFhMPcol
&Regions.N=ainUEQqh
&OrganizationIds.N=BZLMCvrq

Response Example


{
  "Action": "GetOrderAmountResponse",
  "BonusAmount": "wqQkjckV",
  "CashAmount": "Hsbcqacs",
  "CouponAmount": "ZRcRUuyv",
  "Data": {},
  "OrderCount": 7,
  "PaidAmount": "SiiWorjy",
  "PaidCount": 8,
  "RetCode": 0,
  "StarCardAmount": "fEuXwTFD",
  "UnpaidAmount": "TaOEmaIs",
  "UnpaidCount": 5
}