支払い方法の取得
ローカル記録の既定の支払い方法を取得
中国本土のユーザー向け: 中国本土のユーザーは https://api.toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://api.toapis.com を https://api.toapis.cn に置き換えてください.
認証, ページ分割, エラーは利用方法を参照してください.
動作
現在連携している支払い方法の要約を返し, カードが設定済みかを確認できます. 自身の請求を照会できるのは主アカウントのみで, サブアカウントは HTTP 403, 主アカウントも本エンドポイントでメンバー請求は参照できません.
source=local_configuration は, ローカルに保存された既定カードの要約を返すことを意味し, Stripe へのリアルタイム照会や全カード一覧ではありません. 支払い方法未登録時は configured=false で他のカードフィールドは null です. 登録済みでも個別フィールドは null の場合があります.
完全なカード番号や支払い方法 ID は返しません. このエンドポイントは読み取り専用で, カード登録や Stripe の Customer 作成には使えません.
認証
Authorizationstringヘッダー必須Bearer YOUR_SYSTEM_ACCESS_TOKEN を使用します. モデル API キーは使用できません. X-User-Id は不要です.
リクエストパラメータ
パスパラメータ, クエリパラメータ, リクエストボディは使用しません.
リクエスト例
リクエスト例
curl --request GET \
--url 'https://api.toapis.com/api/v1/billing/payment-method' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'import requests
response = requests.get(
"https://api.toapis.com/api/v1/billing/payment-method",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.toapis.com/api/v1/billing/payment-method");
const response = await fetch(url, {
headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());レスポンスフィールド
例は架空のデータで, credits_per_usd="100" を仮定しています. 実際の換算にはレスポンスの値を使用してください.
codeinteger結果コード. 0 は成功です.
messagestring成功時は空文字列です. エラーメッセージは翻訳されます.
dataobject今回の照会結果オブジェクトです.
data.configuredboolean既定カードの設定状態です. false ならカード情報は null です.
data.providerstring | null決済サービスの提供元です. 不明または対象外の場合は null です.
data.typestring | null既定決済方法の種類で, 例は card です. 不明または対象外の場合は null です.
data.brandstring | null既定カードのブランドで, 例は visa です. 不明または対象外の場合は null です.
data.last4string | null既定カード番号の下 4 桁です. 番号全体は返しません. 不明または対象外の場合は null です.
data.exp_monthinteger | null既定カードの有効期限の月です. 不明または対象外の場合は null です.
data.exp_yearinteger | null既定カードの有効期限の年です. 不明または対象外の場合は null です.
data.sourcestringデータソースです. ローカル設定や台帳の値は Stripe のリアルタイム状態を意味しません. 固定値: "local_configuration".
レスポンス例
レスポンス例
{
"code": 0,
"message": "",
"data": {
"configured": true,
"provider": "stripe",
"type": "card",
"brand": "visa",
"last4": "4242",
"exp_month": 12,
"exp_year": 2028,
"source": "local_configuration"
}
}