AM
JA
無料で始める
メニュー

Payment

アカウント内の支払いを追跡するための金融取引レコード。

payments支払いtransactions取引billing請求

Payment

Payment は Account に対する金銭取引を記録します。Payment は Stripe から同期することも、手動で記録することもできます。

スキーマ

interface Payment {
  id: string; // "pay..." - 一意識別子
  account_id: string;
  amount_cents: number;
  currency: string;
  status: "pending" | "succeeded" | "failed" | "canceled" | "refunded";
  paid_at: string | null;
  payment_method: string | null;
  external_id: string | null;
  external_customer_id: string | null;
  external_data: unknown | null;
}

プロパティ

Property Type Description
id string pay プレフィックス付き KSUID
account_id string 所有アカウント
amount_cents number 最小通貨単位(cents)での金額
currency string ISO 4217 通貨コード
status enum 支払いライフサイクル状態
paid_at string? 支払い成功時刻
payment_method string? 支払い手段種別
external_id string? プロバイダ側の支払い ID
external_customer_id string? プロバイダ側の顧客 ID
external_data object? プロバイダの生スナップショット

ステータス値

Status Description
pending 処理待ち
succeeded 支払い完了
failed 支払い失敗
canceled 支払いキャンセル
refunded 顧客へ返金済み

{
  "id": "pay123",
  "account_id": "acc456",
  "amount_cents": 9900,
  "currency": "usd",
  "status": "succeeded",
  "paid_at": "2026-01-15T10:30:00Z",
  "payment_method": "card",
  "external_id": "pi_abc123",
  "external_customer_id": "cus_xyz789"
}

関連