メインコンテンツへスキップ

AccessPass.requestPurchaseIfNeeded()

AccessPass.requestPurchaseIfNeeded({ amount, name, productId, statementDescriptor, accessDurationDays, currency, language })

概要​

お客様が指定されたアクセスパスの支払いを安全に行えるチェックアウトウィンドウを開きます。

有効なアクセスパスが過去にすでに購入されている場合、返されたPromiseは直ちに前回の購入に関する情報とともに解決されます。

このAPIで提供されるパラメータは、モジュール構成で提供されるパラメータに優先して適用されます。

パラメータ​

パラメータタイプ説明
amountNumber指定されたアクセスパスの支払いを要求するための金額です。
金額は、 通貨によって定義されるように、それぞれの最小値と最大値を有します。
AUD: $0.99 to $99.99
CAD: $0.99 to $99.99
GBP: £0.99 to £99.99
JPY: ¥99 to ¥999
NZD: $0.99 to $99.99
USD: $0.99 to $99.99
nameString商品名です。 これは、チェックアウト画面でユーザーに表示されます。 最大30文字までです。
productIdStringこのアクセスパスの一意の識別子です。 最大30文字までです。
statementDescriptorStringお客様のクレジットカードの明細書に記載される記述です。 最大22文字までです。
accessDurationDaysNumberお客様がアクセスできる日数です。 最小の値が1、最大の値が7です。
currencyStringユーザーに請求する通貨です。 aud', 'cad', 'gbp', 'jpy', 'nzd', または 'usd' を指定することができます。
languageString安全なチェックアウトページでエンドユーザーに表示される言語です。 'en-US' (英語 - 米国) または 'ja-JP' (日本語) が可能です。

戻り値​

お客様が購入を正常に完了したかどうかを判断するPromiseです。 結果には、購入された方の情報が含まれています。

{
  productId: '1-day-access-pass',
  timestamp: 1653413347810,
  expirationTimestamp: 1653499747810,
}

エラー​

お客様が購入を正常に完了しない場合、エラーが発生します。

例​

AccessPass.requestPurchaseIfNeeded({
    amount: 9.99,
    name: '1-Day Access Pass',
    productId: '1-day-access-pass',
    statementDescriptor: '1DAY ACCESS PASS',
    accessDurationDays: 1,
    currency: 'usd',
    language: 'en-US',
})