Query cash coupons by using the QueryCashCoupons API - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries user voucher information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeCoupons

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExpiryTimeEnd	string	No	The end of the expiration time range for the voucher. Format: yyyy-MM-ddTHH:mm:ssZ.	2018-08-01T00:00:00Z
ExpiryTimeStart	string	No	The start of the expiration time range for the voucher. Format: yyyy-MM-ddTHH:mm:ssZ.	2018-09-01T00:00:00Z
EffectiveOrNot	boolean	No	Specifies whether the voucher is valid. Valid values: true false	true

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The execution result message.	Successful！
RequestId	string	The request ID.	147B566E-DB4C-4E43-BDBB-5DB1D9D268DB
Success	boolean	Indicates whether the call is successful. Valid values: true (the call is successful) and false (the call fails).	true
Data	object
CashCoupon	array<object>	The returned data.
	object
Status	string	The status of the voucher. Valid values: Available: The voucher is valid. Expired: The voucher has expired. Cancelled: The voucher is canceled.	Available
ExpiryTime	string	The expiration time of the voucher in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2018-08-10T00:00:00Z
GrantedTime	string	The time when the voucher was issued in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2018-08-02T15:15:50Z
NominalValue	string	The face value of the voucher.	100.00
EffectiveTime	string	The effective period of the voucher in ISO 8601 UTC format (YYYY-MM-DDTHH:mm:ssZ).	2018-08-02T15:15:50Z
ApplicableScenarios	string	The description of applicable scenarios.	Pay-as-you-go bills, new purchases
CashCouponId	integer	The ID of the voucher.	34534253254325
ApplicableProducts	string	The description of applicable products.	General
CashCouponNo	string	The voucher code.	Q-b1485def8f04a
Balance	string	The balance.	100.00
Description	string	The remarks.	This voucher is used for product feature verification tests

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "147B566E-DB4C-4E43-BDBB-5DB1D9D268DB",
  "Success": true,
  "Data": {
    "CashCoupon": [
      {
        "Status": "Available",
        "ExpiryTime": "2018-08-10T00:00:00Z",
        "GrantedTime": "2018-08-02T15:15:50Z",
        "NominalValue": "100.00",
        "EffectiveTime": "2018-08-02T15:15:50Z",
        "ApplicableScenarios": "阿里云按量付费账单,阿里云新购",
        "CashCouponId": 34534253254325,
        "ApplicableProducts": "通用",
        "CashCouponNo": "Q-b1485def8f04a",
        "Balance": "100.00",
        "Description": "该代金券用于产品功能验证的测试"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	NotApplicable	This API is not applicable for caller.
400	NotAuthorized	This API is not authorized for caller.
400	MissingParameter	Some parameters arte mandatoryfor this request.
400	InvalidParameter	Some parameter sare not valid.
400	InvalidOwner	The specifiedowner doesn’t belong to caller
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
500	UndefinedError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.