# サブスクリプションで Boleto を使用する サブスクリプションで Boleto を使用する方法をご紹介します。 > #### Accounts v2 API を使用した顧客の表現 > > Accounts v2 API では、Connect ユーザーには一般提供され、その他の Stripe ユーザーには公開プレビューで提供されます。Accounts v2 プレビューの一部である場合は、コードで[プレビューバージョン](https://docs.stripe.com/api-v2-overview.md#sdk-and-api-versioning)を指定する必要があります。 > > Accounts v2 プレビューへのアクセスをリクエストするには、 > > ほとんどのユースケースでは、[Customer](https://docs.stripe.com/api/customers.md) オブジェクトを使用するのではなく、[顧客を顧客設定済みの Account オブジェクトとしてモデル化する](https://docs.stripe.com/accounts-v2/use-accounts-as-customers.md)ことをお勧めします。 [Boleto](https://docs.stripe.com/payments/boleto.md) を*支払い方法* (PaymentMethods represent your customer's payment instruments, used with the Payment Intents or Setup Intents APIs)として設定する方法をご紹介します。Boleto は、生成番号が記載された支払い票であり、*顧客* (Customer objects represent customers of your business. They let you reuse payment methods and give you the ability to track multiple payments)は ATM、銀行、オンラインバンクポータル、または公認の代理店から取得できます。 ## Boleto を有効にする 導入を開始する前に、[サブスクリプションとメール通知の設定](https://dashboard.stripe.com/settings/billing/automatic)の** 確認を必要とする支払いの管理**にアクセスし、**必要に応じて顧客が支払いを確定できるように、Stripe が提供するリンクを送信する**を有効にします。 [決済手段の設定](https://dashboard.stripe.com/settings/payment_methods)に移動し、決済手段として Boleto を有効にします。**設定**をクリックして、店舗支払いの有効期限の延長を設定できます。 ## 回収方法を決定する ダッシュボードまたは [API](https://docs.stripe.com/api/invoices/create.md#create_invoice-collection_method) で回収方法を設定できます。インボイスについては、インボイスを送信するか、顧客に自動請求するかを選択できます。API を使用している場合、`send_invoice` および `charge_automatically` の値によって回収方法が決定します。 | | 請求書を送信する | 自動的に請求する | | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | 使用するタイミング | - 顧客は、請求書またはサブスクリプションの支払いに使用する支払い方法を定義していません。このr例では、クレジットカードまたは Boleto のいずれかを使用するオプションを提供できます。 - Boleto を使用するために必要となる重要な顧客情報 (氏名、住所、納税者番号) を入手していない。 | - 顧客はすでに Boleto を使用して請求書またはサブスクリプションを支払うことを選択している。 - Boleto を使用する請求書を作成するために必要な顧客情報 (氏名、住所、納税番号) を入手済みである。 | | 顧客体験 | - 新しい請求書を送るたびに、または新しいサブスクリプションサービス期間ごとに、顧客は個人情報 (氏名、住所、納税者番号) を再入力しなければなりません。この回収方法では、その顧客に関連付けられたデフォルトの決済手段は考慮されません。 | - 顧客が Boleto をデフォルトの決済手段に設定している場合、請求書送信またはサブスクリプションサービス期間のたびに、Boleto の店舗決済が記載されたメールが顧客に届きます。 | | 有効期限と期日 | - 請求書には期日を含めてください。 - 必要な詳細情報を顧客が入力するとすぐに、請求書の期日に関係なく Boleto が作成される。Boleto には独自の有効期限 (デフォルトは 3 日) があるため、請求書の期日と Boleto の有効期限は必ずしも一致しません。Boleto の有効期限は、請求書の期日より前である場合も後である場合もあります。 | - 請求書に期日が設定されてない。 - 加盟店が有効期限 (デフォルトは 3 日) を選択して請求書を作成すると、Boleto が作成される。 | ## 顧客を作成する 請求対象の新しいユーザーまたはビジネスごとに顧客を作成します。新しい顧客を作成するときに、[最小限の顧客プロフィール](https://docs.stripe.com/payments/boleto/set-up-subscription.md#customer-profile)を設定して、より便利な請求書を生成し、Smart Retries を有効にします ([Invoicing Plus](https://stripe.com/invoicing/pricing) ユーザーの場合) 。顧客を設定すると、1 回限りの請求書の発行や、*サブスクリプション* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis)の作成を実行できます。 > 新しい顧客を作成する前に、顧客がダッシュボードにすでに存在していないことを確認します。同じ顧客に対して複数の顧客のエントリーを作成すると、後で取引履歴を照合するときや保存された支払い方法を調整するときなどに、問題が発生する可能性があります。 #### ダッシュボード コードを使用せずに顧客を作成したい場合や、1 回限りの請求書で顧客に手動で請求したい場合は、[顧客ページ](https://dashboard.stripe.com/customers)で顧客を作成して管理できます。請求書の作成時にダッシュボードで顧客を作成することもできます。 ### 顧客を作成する 新しい顧客を作成するときに、**メールアドレス**、**名前**、**国**などの顧客のアカウント情報や請求先情報を設定できます。顧客の利用言語、通貨、その他の重要な詳細情報も設定できます。 顧客を作成するには、次の手順を実行します。 1. 顧客が存在しなくなっていることを確認します。 1. **顧客**ページで、**顧客を追加**をクリックするか、**N** を押します。 1. 少なくとも、顧客の**名前**と**アカウントのメールアドレス**を入力してください。 1. ダイアログで**顧客を追加**をクリックします。 ### 顧客を編集する 顧客のプロフィールを編集するには、次の手順を実行します。 1. **顧客**ページで、変更する顧客を見つけ、名前をクリックします。 1. アカウント情報ページで、**アクション** > **情報を編集**を選択します。 1. 顧客プロフィールを変更します。 1. **顧客情報を更新**をクリックします。 ### 顧客を削除する 顧客を削除するには、次の手順を実行します。 1. **顧客**ページで、削除する顧客を見つけます。 1. 顧客の名前の横にあるチェックボックスをクリックしてから、**削除**をクリックします。また、顧客の詳細ページをクリックして、**アクション** > **顧客を削除**を選択することもできます。 #### API 新しい顧客を作成する前に、顧客がすでに存在していないことを確認します。たとえば、[全顧客の一覧表示](https://docs.stripe.com/api/customers/list.md) API にメールアドレスを渡します。 ```curl curl -G https://api.stripe.com/v1/customers \ -u "<>:" \ -d email={EMAIL_ADDRESS} ``` 支払い方法として Boleto を使用する新しい顧客を作成する方法をご紹介します。詳細については、[Create a customer](https://docs.stripe.com/api/customers/create.md) をご覧ください。 #### 請求書をメールで送信する ```curl curl https://api.stripe.com/v1/customers \ -u "<>:" \ --data-urlencode "email=joao@exemplo.com" \ -d "description=My first test customer" ``` #### 顧客に自動的に請求する ### 顧客を設定する `name`、`email`、および `description` を指定して顧客を作成するには、次のコードを追加します。 ```curl curl https://api.stripe.com/v1/customers \ -u "<>:" \ -d "name=João da Silva" \ --data-urlencode "email=joao@exemplo.com" \ -d "description=My first test customer" ``` ### Boleto を支払い方法として作成する Boleto を支払い方法として作成するには、次のコードを追加します。 ```curl curl https://api.stripe.com/v1/payment_methods \ -u "<>:" \ -d type=boleto \ -d "boleto[tax_id]=000.000.000-00" \ -d "billing_details[name]=João da Silva" \ --data-urlencode "billing_details[email]=joao@exemplo.com" \ -d "billing_details[address][line1]=1234 Av. Paulista" \ -d "billing_details[address][city]=São Paulo" \ -d "billing_details[address][state]=SP" \ -d "billing_details[address][postal_code]=01310-000" \ -d "billing_details[address][country]=BR" ``` ### その支払い方法 (Boleto) を顧客に関連付ける 支払い方法として Boleto を顧客に関連付けるには、次のコードを追加します。 ```curl curl https://api.stripe.com/v1/payment_methods/{{PAYMENT_METHOD_ID}}/attach \ -u "<>:" \ -d customer={{CUSTOMER_ID}} ``` ### その顧客のデフォルトの支払い方法を設定する 顧客のデフォルトの支払い方法として Boleto を設定するには、次のコードを追加します。 ```curl curl https://api.stripe.com/v1/customers/{{CUSTOMER_ID}} \ -u "<>:" \ -d "invoice_settings[default_payment_method]={{PAYMENT_ID}}" ``` ## 商品と価格を作成する ビジネスと提供商品を一元的に定義します。*Products* (Products represent what your business sells—whether that's a good or a service) は販売品目を定義し、*Prices* (Prices define how much and how often to charge for products. This includes how much the product costs, what currency to use, and the interval if the price is for subscriptions) は請求金額と請求頻度を追跡します。これは Stripe の中核となるエンティティーであり、*サブスクリプション* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis)、*請求書* (Invoices are statements of amounts owed by a customer. They track the status of payments from draft through paid or otherwise finalized. Subscriptions automatically generate invoices, or you can manually create a one-off invoice)、および [Checkout](https://docs.stripe.com/payments/checkout.md) と連携します。 Prices は以下のユースケースを実現します。 - ソフトウェアプロバイダーが、ユーザーが新しいサブスクリプションを作成するたびに 1 回限りの設定手数料を請求する。 - 月額 10 ドルの商品ボックスを継続的に配送する E-コマースストアで、顧客が 1 回限りのアドオンも購入できるようにする。 - プロフェッショナルサービスの提供企業が、手作業で各ラインアイテムを入力するのではなく、標準的なサービスのリストを作成し、請求書ごとにそのリストから選択できるようにする。 - 非営利組織で、各寄付者がカスタムの継続的な寄付金額を各自で定義できるようにする。 商品と価格を使用して、商品カタログを管理できます。商品は販売するものを定義し、価格は請求額と請求頻度を追跡します。商品と価格は、ダッシュボードまたは API を使用して管理します。 #### ダッシュボード *サンドボックス* (A sandbox is an isolated test environment that allows you to test Stripe functionality in your account without affecting your live integration. Use sandboxes to safely experiment with new features and changes)のダッシュボードでビジネスを設定した場合は、[商品カタログページ](https://dashboard.stripe.com/products)の**本番環境にコピー**を使用して、本番環境に各商品をコピーできます。Stripe の公式ライブラリを使用して、アプリケーションから Stripe API にアクセスします。 1. **商品カタログ**ページに移動し、**商品を追加**をクリックします。 1. **一度限りの商品**または**定期利用する商品**のどちらを作成するかを選択します。 1. 商品に名前を指定して、価格を割り当てます。 #### API [Product (商品)](https://docs.stripe.com/api/products.md) と [Price (価格)](https://docs.stripe.com/api/prices.md) を作成する方法をご紹介します。 > [Stripe CLI](https://docs.stripe.com/stripe-cli.md) または API の使用の開始に関する詳細なガイドは、[Invoicing のエンドツーエンドの導入ガイド](https://docs.stripe.com/invoicing/integration.md)をご覧ください。 ### 商品を作成する 商品を作成するには、その名前を入力します。 ```curl curl https://api.stripe.com/v1/products \ -u "<>:" \ -d "name=Gold Special" ``` ### 価格を作成する [Price (価格)](https://docs.stripe.com/api.md#prices) には、商品の価格と請求期間を定義します。これには、商品の価格、使用通貨、およびサブスクリプションの価格の場合は請求期間も含まれます。商品と同様に、価格の種類が少ない場合はダッシュボードで管理することをお勧めします。単価は、当該通貨の最小単位で示します。この場合はセントになります (10 USD は 1,000 セントのため、単価は 1000)。 商品の価格を作成する必要がない場合は、インボイスアイテムの作成時に [amount](https://docs.stripe.com/api/invoiceitems/create.md#create_invoiceitem-amount) パラメーターを使用できます。 価格を作成してそれを商品に割り当てるには、商品 ID、単価、および通貨を指定します。次の例では、「Gold Special」商品の価格は 10 USD です。 ```curl curl https://api.stripe.com/v1/prices \ -u "<>:" \ -d "product={{PRODUCT_ID}}" \ -d unit_amount=1000 \ -d currency=usd ``` > #### 地域に合わせた料金設定 > > API で[請求書の項目を作成](https://docs.stripe.com/api/invoiceitems/create.md)するか、または請求を行う際、Stripe は明示的に指定された金額と通貨を処理します。ローカライズされた価格は自動的に計算されないため、顧客のリージョンに合った正しい金額と通貨を渡す必要があります。価格 ID を渡すには、[pricing.price](https://docs.stripe.com/api/invoiceitems/create.md#create_invoiceitem-pricing-price) パラメーターの使用を推奨します。 ## サブスクリプションを作成する サブスクリプションの作成と更新は、ダッシュボードまたは API から行うことができます。管理するサブスクリプションが多数ある場合、またはプログラムでサブスクリプションを管理する場合は、API を使用します。 > [サブスクリプションの実装全体を構築](https://docs.stripe.com/billing/subscriptions/build-subscriptions.md)する方法については、導入ガイドをご覧ください。 #### ダッシュボード ### サブスクリプションを作成する サブスクリプションを作成するには、以下のようにします。 1. **支払い** > **サブスクリプション**ページに移動します。 1. **+サブスクリプションを作成する**をクリックします。 1. 顧客を検索または追加します。 1. 料金体系と商品の情報を入力します。ここでは、複数の商品、クーポン、またはサブスクリプションのトライアルを追加できます。 **詳細設定**セクションでは、オプションで[従量利用のしきい値](https://docs.stripe.com/products-prices/pricing-models.md#usage-based-pricing)を作成するか、[カスタマイズされた請求書](https://docs.stripe.com/invoicing/customize.md)のフィールドを追加できます。完了したら、**サブスクリプションのスケジュール**または**サブスクリプションを開始**をクリックします。サブスクリプションのスケジュールでは、開始時期を即時、翌月、またはカスタマイズした日に設定できます。サブスクリプションの停止時期は、即時、複数のサイクル後、またはカスタマイズした日付に設定できます。 ### サブスクリプションを編集する サブスクリプションを編集するには、以下のようにします。 1. **支払い** > **サブスクリプション**ページに移動します。 1. 変更するサブスクリプションを探し、オーバーフローメニュー (⋯) をクリックし、**サブスクリプションを更新**をクリックします。サブスクリプション名の横にある ✏ edit icon をクリックすることもできます。このメニューから以下の操作も実行できます。 - **サブスクリプションをキャンセル** サブスクリプションをすぐにキャンセルする日、現在の期間の終了日、またはカスタムの日付を選択します。このサブスクリプションの最新の決済を返金し、記録のために[クレジットノート](https://docs.stripe.com/invoicing/dashboard/credit-notes.md)を作成するオプションを、選択することも可能です。 - **支払いの回収を一時停止**: 一時停止の期間 (無期限または指定の日付まで) と、一時停止中の請求書の動作を選択します。 - **決済更新リンクを共有**: 顧客が[サブスクリプションの決済手段を更新](https://docs.stripe.com/billing/subscriptions/payment-methods-setting.md#update-payment-method)するために使用できるリンクを作成します。 1. サブスクリプションに変更を加えます。 1. **サブスクリプションを更新**をクリックします。 ### サブスクリプションを削除する サブスクリプションオブジェクトは削除できませんが、キャンセルしたり、決済の回収を一時停止したりすることはできます。詳細については、[サブスクリプションの編集](https://docs.stripe.com/payments/boleto/set-up-subscription.md#edit-subscription)をご覧ください。 #### API ### サブスクリプションを作成する [サブスクリプション](https://docs.stripe.com/api/subscriptions.md)を作成すると、サイクルごとに請求書を顧客にメールで送信したり、顧客に自動的に請求したりできます。 #### 請求書をメールで送信する サブスクリプションを作成して、期間ごとに顧客に請求書をメールで送るには、次のコードを入力します。 ```curl curl https://api.stripe.com/v1/subscriptions \ -u "<>:" \ -d customer={{CUSTOMER_ID}} \ -d "items[0][price]={{RECURRING_PRICE_ID}}" \ -d collection_method=send_invoice \ -d payment_behavior=default_incomplete \ -d "payment_settings[payment_method_types][0]=card" \ -d "payment_settings[payment_method_types][1]=boleto" \ -d days_until_due=3 ``` #### 顧客に自動的に請求する サブスクリプションを作成して、期間ごとに顧客に自動的に請求するには、次のコードを入力します。 ```curl curl https://api.stripe.com/v1/subscriptions \ -u "<>:" \ -d customer={{CUSTOMER_ID}} \ -d "items[0][price]={{RECURRING_PRICE_ID}}" \ -d collection_method=charge_automatically \ -d payment_behavior=default_incomplete \ -d off_session=true ``` ### Checkout セッションを使用する [Checkout セッション](https://docs.stripe.com/api/checkout/sessions.md)を使用してサブスクリプションを作成することもできます。Stripe は、サブスクリプションサイクルごとに、以前に生成された Boleto を顧客のメールアドレスに送信します。 ```curl curl https://api.stripe.com/v1/checkout/sessions \ -u "<>:" \ -d mode=subscription \ -d customer={{CUSTOMER_ID}} \ -d "line_items[0][price]={{RECURRING_PRICE_ID}}" \ -d "line_items[0][quantity]=1" \ -d "payment_method_options[boleto][expires_after_days]=3" \ --data-urlencode "success_url=https://example.com/success" ``` ### サブスクリプションのスケジュールを使用する 顧客によっては、サブスクリプションを後日開始するようにスケジュールを設定したり、一度に 1 年分のサービスのみ登録したりするよう希望されることがあります。[サブスクリプションスケジュール](https://docs.stripe.com/api/subscription_schedules.md)を使用すると、後日開始するように継続料金でフェーズを設定したり、特定の日付に終了するように設定したりすることができます。フェーズの開始時に 1 回限りの購入をバンドルする場合は、フェーズで `add_invoice_items` を使用します。 #### curl ```bash curl https://api.stripe.com/v1/subscription_schedules \ -u <>: \ -d customer="{{CUSTOMER_ID}}" \ -d start_date=1780272000 \ -d "phases[0][items][0][price]={{RECURRING_PRICE_ID}}" \ -d "phases[0][add_invoice_items][0][price]={{PRICE_ID}}" ``` これにより、開始予定の月額 10 USD のサブスクリプションがスケジュールされ、初回の請求書に 1 回限りの手数料である 20 ドルも記載されます。 `add_invoice_items` を将来のフェーズに設定する場合、そのフェーズが開始されるまで請求書アイテムは生成されません。`add_invoice_items` を現在のフェーズに設定すると、請求書アイテムは直ちに生成されます。 ## See also - [サブスクリプションの仕組み](https://docs.stripe.com/billing/subscriptions/overview.md)