PaymentSubscription
Subscription
サブスクリプション管理を担当する Sub-Feature
概要
Payment.Subscription は Stripe サブスクリプションの作成・更新・キャンセル・取得を担当する。
API
Handler
| 関数 | 説明 |
|---|---|
createSubscription(input) | サブスクリプションを作成 |
cancelSubscription(input) | サブスクリプションをキャンセル |
updateSubscription(input) | サブスクリプションを更新 |
retrieveSubscription(input) | サブスクリプションを取得 |
Service
| 関数 | 説明 |
|---|---|
createSubscription(input) | 作成処理 |
cancelSubscription(input) | キャンセル処理 |
updateSubscription(input) | 更新処理 |
retrieveSubscription(input) | 取得処理 |
Schema
| スキーマ | 型 | 説明 |
|---|---|---|
SubscriptionStatusSchema | "active" | "past_due" | "unpaid" | "canceled" | "incomplete" | "incomplete_expired" | "trialing" | "paused" | ステータス |
SubscriptionSchema | Subscription | サブスクリプション |
CreateSubscriptionInputSchema | CreateSubscriptionInput | 作成入力 |
CancelSubscriptionInputSchema | CancelSubscriptionInput | キャンセル入力 |
UpdateSubscriptionInputSchema | UpdateSubscriptionInput | 更新入力 |
RetrieveSubscriptionInputSchema | RetrieveSubscriptionInput | 取得入力 |
使用例
import { Payment } from "@unitto/features";
const subscription = await Payment.Subscription.Handler.createSubscription({
customerId: "cus_xxx",
priceId: "price_xxx",
trialPeriodDays: 14,
});
await Payment.Subscription.Handler.cancelSubscription({
subscriptionId: subscription.id,
});