QueryCashCoupons - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the information about vouchers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ExpiryTimeEnd	string	No	The end time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.	2018-08-01T00:00:00Z
ExpiryTimeStart	string	No	The start time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.	2018-08-01T00:00:00Z
EffectiveOrNot	boolean	No	Specifies whether the voucher takes effect. Valid values: true: The voucher takes effect. false: The voucher does not take effect.	true

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The message returned.	Successful
RequestId	string	The ID of the request.	147B566E-DB4C-4E43-BDBB-5DB1D9D268DB
Success	boolean	Indicates whether the request is successful.	true
Data	array<object>	The data returned.
	object
Status	string	The state of the voucher. Valid values: Available: The voucher is valid. Expired: The voucher has expired. Cancelled: The voucher is canceled.	Available
ExpiryTime	string	The time when the voucher expired.	2019-01-29T15:15:50Z
GrantedTime	string	The time when the voucher was released.	2018-08-02T15:15:50Z
NominalValue	string	The denomination of the voucher.	100.00
EffectiveTime	string	The time when the voucher took effect.	2018-08-02T15:15:50Z
ApplicableScenarios	string	The scenario to which the voucher is applicable.	Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service
CashCouponId	long	The ID of the voucher.	34534253254325
ApplicableProducts	string	The service to which the voucher is applicable.	All Alibaba Cloud services
CashCouponNo	string	The code of the voucher.	Q-b1485def8f04a
Balance	string	The remaining quota of the voucher.	100.00
Description	string	The description of the voucher.	This voucher is used for testing product function

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "147B566E-DB4C-4E43-BDBB-5DB1D9D268DB",
  "Success": true,
  "Data": {
    "CashCoupon": [
      {
        "Status": "Available",
        "ExpiryTime": "2019-01-29T15:15:50Z",
        "GrantedTime": "2018-08-02T15:15:50Z",
        "NominalValue": "100.00",
        "EffectiveTime": "2018-08-02T15:15:50Z",
        "ApplicableScenarios": "Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service\n",
        "CashCouponId": 34534253254325,
        "ApplicableProducts": "All Alibaba Cloud services\n",
        "CashCouponNo": "Q-b1485def8f04a",
        "Balance": "100.00",
        "Description": "This voucher is used for testing product function"
      }
    ]
  }
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-19	The Error code has changed. The response structure of the API has changed	View Change Details