PaymentBilling
Billing
請求書の作成・管理を担当する Sub-Feature
概要
Payment.Billing は Stripe の請求書（Invoice）の作成・取得・一覧・確定を担当する。
API
Handler
| 関数 | 説明 |
|---|---|
createInvoice(input) | 請求書を作成 |
retrieveInvoice(input) | 請求書を取得 |
listInvoices(input) | 請求書一覧を取得 |
finalizeInvoice(input) | 請求書を確定 |
Service
| 関数 | 説明 |
|---|---|
createInvoice(input) | 請求書作成処理 |
retrieveInvoice(input) | 請求書取得処理 |
listInvoices(input) | 一覧取得処理 |
finalizeInvoice(input) | 確定処理 |
Schema
| スキーマ | 型 | 説明 |
|---|---|---|
InvoiceStatusSchema | "draft" | "open" | "paid" | "void" | "uncollectible" | 請求書ステータス |
InvoiceSchema | Invoice | 請求書 |
CreateInvoiceInputSchema | CreateInvoiceInput | 作成入力 |
RetrieveInvoiceInputSchema | RetrieveInvoiceInput | 取得入力 |
ListInvoicesInputSchema | ListInvoicesInput | 一覧入力 |
FinalizeInvoiceInputSchema | FinalizeInvoiceInput | 確定入力 |
使用例
import { Payment } from "@unitto/features";
const invoice = await Payment.Billing.Handler.createInvoice({
customerId: "cus_xxx",
description: "月額利用料",
});
await Payment.Billing.Handler.finalizeInvoice({
invoiceId: invoice.id,
});