ソースと顧客非推奨

Source (ソース) オブジェクトはその usage パラメータが示すように、1 回限り使用または再利用できます。ソースは直接請求を受けられますが、「再利用可能な」ソースは、後で再利用するために常に Customer (顧客) オブジェクトに関連付ける必要があります。再利用可能なソースを Customer に関連付けることにより、顧客が以前お客様のアプリまたはウェブサイトで使用した再利用可能な支払い方法のリストを顧客に提示することができます。

再利用可能なソース

一部の支払い方法 (SEPA ダイレクトデビットなど) では、再利用可能な Source がサポートされています。このため、顧客に支払い処理を再度要求することなく、追加の支払いを作成できます。再利用可能なソースでは、usage パラメータが reusable に設定されています。

支払いリクエストを実行する前に、再利用可能なソースを Customer オブジェクトに関連付ける必要があります。最初に関連付けせずに再利用可能なソースに請求した場合、ソースは使い切られます (ステータスは chargeable から consumed に変わります)。使い切られたソースは以降の支払いには使用できません。

新しい Customer オブジェクトにソースを関連付ける

1 回の API コールで、Customer オブジェクトを作成してソースを関連付けることができます。顧客が新規の場合、この方法は便利です。

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  --data-urlencode email="paying.user@example.com" \
  -d source=src_18eYalAHEMiOZZp1l9ZTjSU0

そのソースが顧客の最初で唯一の支払い方法であるため、Customer オブジェクトのデフォルトの支払元になります。source を指定せずに customer パラメータを使用して支払いリクエストを実行すると、デフォルトの支払元が自動的に選択されます。

既存の Customer オブジェクトにソースを関連付ける

デフォルトの支払元が設定された Customer オブジェクトを更新すると、自動的に既存のソースが切り離され、指定されたソースが新しいデフォルトとして追加されます。既存のデフォルトを置き換えずにソースを追加するには、以下のように関連付けを使用します。

curl https://api.stripe.com/v1/customers/cus_AFGbOSiITuJVDs/sources \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "source"="src_18eYalAHEMiOZZp1l9ZTjSU0"

ここでは、デフォルトの支払元がすでに Customer オブジェクトに存在すると考えられるため、新たに関連付けられたソースはデフォルトの支払元になりません。ただし、Customer オブジェクトを更新し、その支払元を default_source の値として指定すれば、デフォルトの支払元を変更することができます。

curl https://api.stripe.com/v1/customers/cus_AFGbOSiITuJVDs \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d default_source=src_18eYalAHEMiOZZp1l9ZTjSU0

関連付けられたソースに請求する

支払いリクエストを作成する際は、Customer オブジェクトとソースの両方を指定する必要があります。

curl https://api.stripe.com/v1/charges \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d amount="1099" \
  -d currency="eur" \
  -d customer=cus_AFGbOSiITuJVDs \
  -d source=src_18eYalAHEMiOZZp1l9ZTjSU0

お客様が支払元を指定せずに Customer オブジェクトに請求しようとした場合、Stripe は顧客のデフォルトの支払元を使用します。

ソースの関連付けを解除する

特定の Customer オブジェクトから支払元を削除する必要がある場合は、ソースの関連付けを解除できます。これにより、支払元のステータスが consumed に変わるため、いったん解除されたものは使用できなくなります。

1 回限りの使用のソース

1 回限りの使用のソースは、顧客が支払いを行うたびに作成する必要があり、再利用できません。このため、これらのソースを顧客に永続的に関連付けることはお勧めしません。

支払いを特定の Customer オブジェクトに関連付けたい場合、ソースを使用して支払いリクエストを作成する際に、そのソースが関連付けられていなくても、customer パラメータを含めることができます。

curl https://api.stripe.com/v1/charges \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d amount="1099" \
  -d currency="eur" \
  -d customer=cus_AFGbOSiITuJVDs \
  -d source=src_18eYalAHEMiOZZp1l9ZTjSU0

このようにして作成される Charge オブジェクトは、互いに直接関連していない場合でも、Customer と Source オブジェクトの両方を参照します。