WP Simple Pay ドキュメント

WP Simple Pay のドキュメント、参考資料、チュートリアル

確認ページとメールでのスマートタグの使用

スマートタグとは?

スマートタグは、支払い確認ページ、領収書、メールで、顧客と支払いに関する関連情報に動的に置き換わるプレースホルダーテキストの一種です。

スマートタグは波括弧を使用し、次のような形式になります。

{smart-tag}

スマートタグの使用方法

スマートタグは、支払い確認ページおよびWP Simple Payのメールで使用できます。これらのユースケースの例については、リンクをクリックしてください。

支払い確認ページ例

以下は、定期払い確認ページのデフォルトテキストです。いくつかのスマートタグが既に使用されています。このドキュメントのさらに下にあるスマートタグ参照リストから、追加のスマートタグを追加できます。

メール例

以下は、請求書支払い確認メールのデフォルトテキストです。いくつかのスマートタグが既に使用されていることに注意してください。このドキュメントのさらに下にあるスマートタグ参照リストから、追加のスマートタグを追加できます。

利用可能なスマートタグ

支払い確認ページとメールをカスタマイズするために、WP Simple Payに組み込まれているスマートタグは次のとおりです。

受領タグ

{receipt}
購入した品目と、購入合計に影響するその他の関連金額の内訳を出力します。

{form-title}
フォームのタイトル値。

**{form-description}
**フォームのアイテム説明値。

**{customer-email}
**メールアドレスフォームフィールドからのメールアドレス

**{customer-name}
**名前フォームフィールドからの名前

**{customer-tax-id}
**税IDフォームフィールドを使用する際に収集された税ID。

**{customer-url}
**Stripeダッシュボードの顧客レコードへの直接リンク

請求先住所のスマートタグ

これらのタグは、Stripeが支払い方法のためにキャプチャした請求先住所を取得します。これらはStripe Checkoutとオンサイト(支払い要素)フォームの両方で利用可能です。請求先住所が収集されなかった場合、タグは空の値に置き換えられます。

{billing-country}
顧客の請求先住所からの2文字の国コード(例:USGBAU)。WP Simple Pay 4.17.2以降で利用可能。

{billing-zip}
顧客の請求先住所からの郵便番号/ZIPコード。WP Simple Pay 4.17.2以降で利用可能。

**{card-brand}
**使用されたカードのブランド。Visa、Amexなど。

**{card-last4}
**使用されたカードの下4桁

**{coupon-amount}
**支払いに適用されたクーポンの金額

**{custom-fields}
**支払いのメタデータに保存されているすべての情報を出力します。

**{charge-date}
**Stripeから返された請求日。

**{charge-id}
**Stripeから返されたチャージID。

**{fee-recovery-amount}
**フォーム合計と手数料回収設定に基づいた計算された手数料回収額

**{payment-type}
**支払いの種類(都度払いまたは継続払い)。

**{payment-url}
**Stripeダッシュボードの支払いレコードへの直接リンク

**{refund-amount}
**処理された返金額

**{refund-date}
**返金が処理された日付

**{subtotal-amount}
**割引や手数料前の金額

**{tax-amount}
**合計金額と税率設定に基づいて計算された税額

**{total-amount}
**支払いの合計金額。

サブスクリプション固有のスマートタグ

**{recurring-amount}
**サブスクリプションの各期間に請求される定期的な金額。トライアルなしのサブスクリプションにのみ適用されます。

**{max-charges}
**分割払いが設定されている場合、サブスクリプションが終了するまでの最大請求回数。トライアルなしのサブスクリプションにのみ適用されます。

**{next-invoice-date}
**定期支払い設定に基づいた、次の請求書支払い日。

**{trial-end-date}
**プランの無料トライアルが終了する日。トライアルありのサブスクリプションにのみ適用されます。

**{update-payment-method-url}
**顧客がサブスクリプションを管理するために使用できる一意のURL。

高度でカスタムなスマートタグの作成

高度なスマートタグ

支払いまたはサブスクリプションに関連する追加情報を出力するには、Stripeオブジェクトデータにアクセスするために **{payment:key}** および **{customer:key}** スマートタグを使用します。

あなたは、顧客、支払い、サブスクリプション、または請求書のレコードのプロパティにアクセスするために、独自のスマートタグを生成できます。例:

例:

  • {[payment](https://stripe.com/docs/api/payment_intents/object):currency}
  • {[](https://stripe.com/docs/api/payment_intents/object)`[subscription](https://docs.stripe.com/api/subscriptions/object)`:currency}
  • {[subscription](https://docs.stripe.com/api/subscriptions/object):[latest_invoice](https://docs.stripe.com/api/invoices/object):number}
  • {[customer](https://docs.stripe.com/api/customers/object):address:line1}
  • {[customer](https://docs.stripe.com/api/customers/object):address:line2}
  • {[customer](https://docs.stripe.com/api/customers/object):address:city}
  • {[customer](https://docs.stripe.com/api/customers/object):address:state}
  • {[customer](https://docs.stripe.com/api/customers/object):address:postal_code}
  • {[customer](https://docs.stripe.com/api/customers/object):phone}
  • {[customer](https://docs.stripe.com/api/customers/object):shipping:address:line1}
  • {[customer](https://docs.stripe.com/api/customers/object):shipping:address:line2}
  • {[customer](https://docs.stripe.com/api/customers/object):shipping:`address:`city}
  • {[customer](https://docs.stripe.com/api/customers/object):shipping:`address:state`}
  • {[customer](https://docs.stripe.com/api/customers/object):shipping:`address:postal_code`}

すべてのネストされたオブジェクトが展開または利用可能であるわけではありません。

これらのカスタムスマートタグを使用すると、よりパーソナルで柔軟な支払い確認ページやメールを作成できます。

カスタムスマートタグ

ユーザーデータを収集するためにカスタムフォームフィールドを使用する場合、そのデータを他の目的で使用したい場合があります。以下に、カスタムフォームフィールドデータを収集し、支払い確認ページやさまざまなメールで使用し、Stripeダッシュボードに記録する方法を示します。

カスタムフィールドを追加する際には、Stripeダッシュボードに表示したいラベルを**Stripeメタデータラベル**エリアに入力します。

適切なスマートタグが自動的に表示されます。

WP Simple Payスマートタグの生成

コピーしたら、そのスマートタグを支払い確認ページ、WP Simple Payのメールなどに貼り付けることができます。

WP Simple Pay スマートタグの使用

支払い確認ページに貼り付けられたスマートタグを示す例

すべてのカスタムフォームフィールドラベルと送信されたデータは、Stripe支払いオブジェクトの**メタデータ**セクションにも自動的に送信されます。

オプションフィールドのフォールバック値

名前フィールドやフォームの説明などのオプションフォームフィールドのスマートタグを追加する際に、通知メールや確認ページにフォールバック値を提供できます。

{customer-name | “Valued customer”}
フォールバック値はオプションフィールドでのみ使用できます

まだ質問がありますか?私たちが喜んでお手伝いします!

最終更新日:

今日から決済を受け付けましょう

WordPressウェブサイトで、単発および定期的な支払いまたは寄付の受け付けを開始しましょう。