TossPay.authorizeSubscription

함수형 API requestTossPayPaysBilling으로도 같은 기능을 쓸 수 있어요. 함수형 API는 v2와 같은 { params: { wrappedToken } } 형태의 인자를 받고, 미지원 버전이면 에러 대신 경고 로그 후 undefined를 반환해요.

기능 설명

토스페이 정기결제창을 띄우고 사용자 인증을 수행해요. 인증이 완료되면 성공 여부를 반환해요.

실제 결제 처리는 인증 성공 후 서버에서 별도로 해야 해요.

토스앱 5.256.0 이상에서 사용할 수 있어요. 호출 전에 TossPay.authorizeSubscription.isSupported()로 지원 여부를 확인할 수 있어요. 지원하지 않는 버전에서 호출하면 UNSUPPORTED_APP_VERSION 에러가 발생해요.

타입

TossPay.authorizeSubscription(params: RequestTossPayPaysBillingOptions): Promise<RequestTossPayPaysBillingResult>;

Params

type RequestTossPayPaysBillingOptions = {
  /** 정기결제 래핑 토큰이에요. */
  wrappedToken: string;
};

Response

type RequestTossPayPaysBillingResult = {
  /** 인증이 성공했는지 여부예요. */
  success: boolean;
  /** 인증이 실패했을 경우의 이유예요. */
  reason?: string;
};

에러 코드

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

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

예시 코드

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

async function handleBilling() {
  try {
    if (!TossPay.authorizeSubscription.isSupported()) {
      console.log("현재 앱 버전에서는 정기결제 인증을 지원하지 않아요.");
      return;
    }

    // 실제 구현 시 정기결제 생성 역할을 하는 API 엔드포인트로 대체해 주세요.
    const { wrappedToken } = await fetch("/my-api/billing/create").then((res) =>
      res.json(),
    );

    const { success, reason } = await TossPay.authorizeSubscription({
      wrappedToken,
    });

    if (success) {
      // 실제 구현 시 정기결제를 실행하는 API 엔드포인트로 대체해 주세요.
      await fetch("/my-api/billing/execute", {
        method: "POST",
        body: JSON.stringify({ wrappedToken }),
        headers: { "Content-Type": "application/json" },
      });
    } else {
      console.log("인증 실패:", reason);
    }
  } catch (error) {
    console.error("정기결제 인증 중 오류가 발생했어요:", error);
  }
}

document
  .querySelector("#billing-button")
  .addEventListener("click", handleBilling);