IAP.getCompletedOrRefundedOrders

功能说明

获取通过应用内购买购买或退款的订单列表。

响应中的 hasNext / nextKey可通过它知道是否有下一页。Web SDK 不接收参数，始终获取第一页。

Toss App Android/iOS 5.231.0 可在以上版本使用。若在不支持的版本中调用则 UNSUPPORTED_APP_VERSION 会发生错误。

类型

IAP.getCompletedOrRefundedOrders(): Promise<CompletedOrRefundedOrdersResult>;

Params

无

Response

type CompletedOrRefundedOrdersResult = {
  hasNext: boolean;
  nextKey?: string | null;
  orders: Array<{
    orderId: string;
    sku: string;
    status: "COMPLETED" | "REFUNDED";
    /** ISO 8601（例如：2025-09-22T00:00:00） */
    date: string;
  }>;
};

错误

错误代码是 catch 到的错误的 error.code 值。

代码	说明
UNSUPPORTED_APP_VERSION	如果当前运行的 Toss App 版本不支持此功能，调用后会立即发生。 IAP.getCompletedOrRefundedOrders.isSupported()可通过它提前确认，发生时 error.message请向用户显示（更新提示文案）。

示例代码

import { IAP } from "@apps-in-toss/web-framework";

try {
  const response = await IAP.getCompletedOrRefundedOrders();
  console.log(response.orders);
} catch (error) {
  console.error(error);
}