getCredentialList(data: GetCredentialListParams)

Requires:
@tuya-miniapp/cloud-api≥1.5.0

Description

Query the user's value-added service vouchers to determine whether the specified service is enabled, and obtain the voucher validity period, usage status, and remaining quota.

Parameters

ParameterTypeRequiredDescription
YesRequest parameters

Return Value

Type: Promise<GetCredentialListResult>
Array of value-added service vouchers; each item includes validity period, status, metering rule, quota usage, and associated order information

Referenced Types

typeGetCredentialListResultResult of querying user service credentials
ServiceCredential[]

Examples

Request example

import { getCredentialList } from '@tuya-miniapp/cloud-api';

getCredentialList({
  catalogCode: 'your_catalog_code',
})
  .then(credentials => {
    console.log('Service credentials:', credentials);
  })
  .catch(error => {
    console.error('Failed to query service credentials:', error);
  });

Response example

[
  {
    "catalogCode": "your_catalog_code",
    "externalCode": "your_external_code",
    "effectiveStartDate": 1699977600000,
    "effectiveEndDate": 1731600000000,
    "objectType": 3,
    "objectId": "your_user_id",
    "state": 2,
    "usageState": "using",
    "metering": {
      "meteringType": 1,
      "meteringUnit": 10,
      "quotaPeriodUnit": 0,
      "quota": 10000
    },
    "performance": {
      "consumeType": 1,
      "consumeInCurrentMonth": true
    },
    "quotaUsage": {
      "leftQuantity": 9000,
      "usedQuantity": 1000
    },
    "order": {
      "orderId": "your_order_id",
      "commodityCode": "your_commodity_code",
      "skuCode": "your_sku_code",
      "subscribeOrder": true
    }
  }
]