TossPay.authorizeSubscription

Functional API requestTossPayPaysBillingYou can use the same functionality with it as well. The function-style API is the same as v2 { params: { wrappedToken } } It takes an argument in the following form, and if the version is not supported, it logs a warning instead of throwing an error and then undefinedis returned.

Feature description

Displays the Toss Pay subscription payment window and performs user authentication. When authentication is complete, it returns whether it succeeded.

Actual payment processing must be done separately on the server after authentication succeeds.

Toss app 5.256.0 You can use it on version and above. Before calling, TossPay.authorizeSubscription.isSupported()You can check support status with Promotion.grantReward.isSupported(). If you call it on an unsupported version, UNSUPPORTED_APP_VERSION an error occurs.

Type

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

Params

type RequestTossPayPaysBillingOptions = {
  /** This is the subscription payment wrapping token. */
  wrappedToken: string;
};

Response

type RequestTossPayPaysBillingResult = {
  /** Whether authentication succeeded. */
  success: boolean;
  /** The reason if authentication failed. */
  reason?: string;
};

Error code

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. TossPay.authorizeSubscription.isSupported()Check in advance with error.messageand, if it occurs, show the user the (update guidance message).

Example code

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

async function handleBilling() {
  try {
    if (!TossPay.authorizeSubscription.isSupported()) {
      console.log("This app version does not support subscription payment authentication.");
      return;
    }

    // Please replace this with the API endpoint that creates the subscription payment in the actual implementation.
    const { wrappedToken } = await fetch("/my-api/billing/create").then((res) =>
      res.json(),
    );

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

    if (success) {
      // Please replace this with the API endpoint that executes the subscription payment in the actual implementation.
      await fetch("/my-api/billing/execute", {
        method: "POST",
        body: JSON.stringify({ wrappedToken }),
        headers: { "Content-Type": "application/json" },
      });
    } else {
      console.log("Authentication failed:", reason);
    }
  } catch (error) {
    console.error("An error occurred during subscription payment authentication:", error);
  }
}

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