IAP.getCompletedOrRefundedOrders

Feature description

Retrieve the list of orders purchased or refunded via in-app purchase.

In the response, hasNext / nextKeyWith this, you can tell whether there is a next page. In the web SDK, it takes no parameters and always fetches the first page.

Toss app Android/iOS 5.231.0 It can be used on versions above. If called in an unsupported version, UNSUPPORTED_APP_VERSION an error occurs.

Type

IAP.getCompletedOrRefundedOrders(): Promise<CompletedOrRefundedOrdersResult>;

Params

None

Response

type CompletedOrRefundedOrdersResult = {
  hasNext: boolean;
  nextKey?: string | null;
  orders: Array<{
    orderId: string;
    sku: string;
    status: "COMPLETED" | "REFUNDED";
    /** ISO 8601 (e.g., 2025-09-22T00:00:00) */
    date: string;
  }>;
};

Error

The error code is the error.code value.

Code	Description
UNSUPPORTED_APP_VERSION	If the running version of the Toss app doesn't support this feature, it occurs immediately upon call. IAP.getCompletedOrRefundedOrders.isSupported()Check in advance with error.messageand, if it occurs, show the user the (update guidance message).

Example code

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

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