IAP.getProductItemList

기능 설명

인앱결제로 구매할 수 있는 상품 목록을 가져와요. 상품 목록 화면에 진입할 때 호출해요.

토스앱 Android/iOS 5.219.0 이상에서 사용할 수 있어요. 미지원 버전에서 호출하면 UNSUPPORTED_APP_VERSION 에러가 발생해요.

타입

IAP.getProductItemList(): Promise<{ products: IapProductListItem[] }>;

Params

없음

Response

type ConsumableProductListItem = {
  sku: string;
  type: "CONSUMABLE";
  displayName: string;
  displayAmount: string;
  iconUrl: string;
  description: string;
};

type NonConsumableProductListItem = {
  sku: string;
  type: "NON_CONSUMABLE";
  displayName: string;
  displayAmount: string;
  iconUrl: string;
  description: string;
};

type Offer =
  | { type: "FREE_TRIAL"; offerId: string; period: string }
  | {
      type: "NEW_SUBSCRIPTION";
      offerId: string;
      period: string;
      displayAmount: string;
    }
  | {
      type: "RETURNING";
      offerId: string;
      period: string;
      displayAmount: string;
    };

type SubscriptionProductListItem = {
  sku: string;
  type: "SUBSCRIPTION";
  displayName: string;
  displayAmount: string;
  iconUrl: string;
  description: string;
  renewalCycle: "WEEKLY" | "MONTHLY" | "YEARLY";
  offers?: Offer[];
};

type IapProductListItem =
  | ConsumableProductListItem
  | NonConsumableProductListItem
  | SubscriptionProductListItem;

에러

에러 코드는 catch한 에러의 error.code 값이에요.

코드	설명
UNSUPPORTED_APP_VERSION	실행 중인 토스앱 버전이 이 기능을 지원하지 않으면 호출 즉시 발생해요. IAP.getProductItemList.isSupported()로 사전 확인하고, 발생 시 error.message(업데이트 안내 문구)를 사용자에게 보여주세요.

예시 코드

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

async function renderProductList() {
  try {
    const response = await IAP.getProductItemList();
    const list = document.querySelector("#product-list");

    for (const product of response.products) {
      const item = document.createElement("li");
      item.textContent = `${product.displayName} · ${product.displayAmount}`;
      list.appendChild(item);
    }
  } catch (error) {
    console.error(error);
  }
}

renderProductList();