支払い方法の取得 | ToAPIs Documentation

GET

/api/v1/account/billing/payment-method

中国本土のユーザー向け: 中国本土のユーザーは https://toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://toapis.com を https://toapis.cn に置き換えてください.

認証, ページ分割, エラーは利用ガイドを参照してください.

動作

メインアカウント自身の請求情報のみ取得できます. サブアカウントは HTTP 403 になります. メンバーの請求情報は取得できません.

source=local_configuration は既定カードのローカル要約で, Stripe のリアルタイム照会や全カード一覧ではありません. 未設定なら configured=false, 他のカード項目は null. 設定済みでも欠損項目は null です. カード番号全体や支払方法 ID は返さず, GET はカード登録や Customer 作成を行いません.

認証

Authorizationstringヘッダー必須

Bearer YOUR_SYSTEM_ACCESS_TOKEN を使用します. モデル API キーは使用できません. X-User-Id は不要です.

パラメータ

パスパラメータ, クエリパラメータ, リクエストボディは使用しません.

リクエスト例

curl --request GET \
  --url 'https://toapis.com/api/v1/account/billing/payment-method' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://toapis.com/api/v1/account/billing/payment-method",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const url = new URL("https://toapis.com/api/v1/account/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"
  }
}