Query information about prepaid cards via QueryPrepaidCards - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries user card package 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:DescrbePrepaidCards

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExpiryTimeEnd	string	No	The end time of card package expiration. Format: yyyy-MM-dd HH:mm:ss.	2018-08-01 00:00:00
ExpiryTimeStart	string	No	The start time of card package expiration. Format: yyyy-MM-dd.	2018-08-01 00:00:00
EffectiveOrNot	boolean	No	Specifies whether the card package is effective. Valid values: true: Effective. false: Ineffective.	true

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful!
RequestId	string	The request ID.	7EA6C02D-06D0-4213-9C3B-E67910F7D1EB
Success	boolean	Indicates whether the request is successful.	true
Data	object
PrepaidCard	array<object>	The returned data.
	object
Status	string	The status of the card package. Valid values: Available: Valid. Expired: Expired. Cancelled: Cancelled.	Available
ExpiryTime	string	The expiration time of the card package. Format: YYYY-MM-DD HH:mm:ss.	2019-08-04 01:39:11
GrantedTime	string	The issuance time of the card package. Format: YYYY-MM-DD HH:mm:ss.	2019-08-04 01:39:11
NominalValue	string	The face value.	100.00
EffectiveTime	string	The effective period of the card package. Format: YYYY-MM-DD HH:mm:ss.	2019-08-04 01:39:11
PrepaidCardNo	string	The card package code.	Q-7edaab979fc9
ApplicableScenarios	string	The description of applicable scenarios.	Alibaba Cloud pay-as-you-go bills, new Alibaba Cloud purchases
PrepaidCardId	integer	The card package ID.	213432432
ApplicableProducts	string	The description of applicable products.	General
Balance	string	The remaining balance.	100.00

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "7EA6C02D-06D0-4213-9C3B-E67910F7D1EB",
  "Success": true,
  "Data": {
    "PrepaidCard": [
      {
        "Status": "Available",
        "ExpiryTime": "2019-08-04 01:39:11",
        "GrantedTime": "2019-08-04 01:39:11",
        "NominalValue": "100.00",
        "EffectiveTime": "2019-08-04 01:39:11",
        "PrepaidCardNo": "Q-7edaab979fc9",
        "ApplicableScenarios": "阿里云按量付费账单,阿里云新购",
        "PrepaidCardId": 213432432,
        "ApplicableProducts": "通用",
        "Balance": "100.00"
      }
    ]
  }
}

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 parameters are 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.