ドキュメント

請求する

サブスクリプション情報、Stripe チェックアウト/ポータル統合、トライアルメンテナンス、署名付き Webhook 取り込み。

英語から自動翻訳されています。英語の原文を見る

プレイグラウンド

これらのリクエストを独自の実行中のサイドカーに送信します。値はこのブラウザ内に残ります。

接続されていません

ベースURL 無記名トークン オプション セッショントークン オプション

仕組み

サイドカーは起動時に選択されたループバックポートをリッスンし、それをそのポートに出力します。 ready ライン;その URL を使用し、 CADCAMFUN_TOKEN で始まりました。リクエストはこのページからそのアドレスに直接送信されます。

サイドカーは CORS ヘッダーを Tauri オリジンと http://localhost または http://127.0.0.1 どのポートでも。ホストされているドキュメントからはブラウザーが応答をブロックするため、ドキュメントをローカルで実行します (bun run dev で packages/web) プレイグラウンドを使用するか、リクエストをcurlとしてコピーします。実際のデータに触れることなく実験するには、次のようにしてサイドカーを開始します。 CADCAMFUN_DATA_DIR 使い捨てディレクトリを指す - を参照 aPI のチュートリアル.

運営

15 エンドポイント（ billing サイドカー自体から生成されたグループ OpenAPIドキュメント。保護された操作には時間がかかります Authorization: Bearer $CADCAMFUN_TOKEN;見る認証。行動と制限は次のとおりですサブシステムガイド.

得る	/api/subscription/info	billing.info
得る	/api/subscriptions	billing.current
役職	/api/subscriptions	billing.subscribe
役職	/api/subscriptions/portal	billing.portal
得る	/api/better-auth-stripe/subscription	billing.baGet
役職	/api/better-auth-stripe/subscription	billing.baCheckout
置く	/api/better-auth-stripe/subscription	billing.baUpdate
消去	/api/better-auth-stripe/subscription	billing.baCancel
役職	/api/better-auth-stripe/billing-portal	billing.baPortal
役職	/api/better-auth-stripe/feature-access	billing.baFeature
役職	/api/better-auth-stripe/sync	billing.baSync
得る	/api/cron/update-expired-trials	billing.cronGet
役職	/api/cron/update-expired-trials	billing.cronPost
得る	/api/health/stripe	billing.stripeHealth
役職	/api/webhooks/stripe	billing.stripeWebhook

3D での請求オペレーションドラッグして周回します · スクロールしてズーム · 右ドラッグしてパンします

オペレーションごとに 1 つのブロック (15)、このページのリソースセクションごとにスタックされ、メソッドごとに色分けされます: 緑色の GET、オレンジ色の POST、青色の PUT、紫色の PATCH、赤色の DELETE。ビルド時に OpenAPI ドキュメントから生成されます。

/api/subscription/info

得る /api/subscription/info # billing.info

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
userId	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  id: string
  plan: string
  status: string
  currentPeriodEnd: string | null
  cancelAtPeriodEnd: boolean | null
  stripeCustomerId: string | null
  stripeSubscriptionId: string | null
}

400 BillingBadRequestEncoded application/json

BillingBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 BillingForbiddenEncoded application/json

BillingForbiddenEncoded

404 BillingNotFoundEncoded application/json

BillingNotFoundEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

応答例捕獲 · 400

/api/サブスクリプション/情報を取得する

{
  "_tag": "BillingBadRequest",
  "error": "User ID is required"
}

SDKの例

billing.info

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingInfoInput
const result = await client.billing.info({})

curl

/api/サブスクリプション/情報を取得する

curl --request GET "${CADCAMFUN_URL}/api/subscription/info" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

userId クエリ

/api/subscriptions

得る /api/subscriptions # billing.current

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  plan: string
  status: string
  periodEnd: string | null
  cancelAtPeriodEnd: boolean
  isOnTrial?: boolean | null
  trialEnd?: string | null
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

応答例捕獲 · 200

/api/サブスクリプションを取得する

{
  "plan": "FREE",
  "status": "active",
  "periodEnd": null,
  "cancelAtPeriodEnd": false
}

SDKの例

billing.current

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.billing.current()

curl

/api/サブスクリプションを取得する

curl --request GET "${CADCAMFUN_URL}/api/subscriptions" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

役職 /api/subscriptions # billing.subscribe

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  priceId?: string | null
  startTrial?: boolean | null
}

応答

200 物体 application/json

{
  url?: string | null
  success?: boolean | null
  message?: string | null
  redirectUrl?: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDKの例

billing.subscribe

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingSubscribeInput
const result = await client.billing.subscribe({
  priceId: "",
  startTrial: false
})

curl

POST /api/サブスクリプション

curl --request POST "${CADCAMFUN_URL}/api/subscriptions" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

/api/subscriptions/portal

役職 /api/subscriptions/portal # billing.portal

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  returnUrl?: string | null
}

応答

200 物体 application/json

{
  url: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDKの例

billing.portal

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingPortalInput
const result = await client.billing.portal({
  returnUrl: ""
})

curl

POST /api/サブスクリプション/ポータル

curl --request POST "${CADCAMFUN_URL}/api/subscriptions/portal" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

/api/better-auth-stripe/subscription

得る /api/better-auth-stripe/subscription # billing.baGet

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  id?: string | null
  plan: string
  status: string
  currentPeriodEnd: string | null
  cancelAtPeriodEnd: boolean
  stripeCustomerId?: string | null
  stripeSubscriptionId?: string | null
  source: "better-auth"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

応答例捕獲 · 200

GET /api/better-auth-ストライプ/サブスクリプション

{
  "id": "c942817d-0162-4291-84ff-77321d387acc",
  "plan": "FREE",
  "status": "active",
  "currentPeriodEnd": null,
  "cancelAtPeriodEnd": false,
  "stripeCustomerId": null,
  "stripeSubscriptionId": null,
  "source": "better-auth"
}

SDKの例

billing.baGet

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.billing.baGet()

curl

GET /api/better-auth-ストライプ/サブスクリプション

curl --request GET "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

役職 /api/better-auth-stripe/subscription # billing.baCheckout

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  plan?: string | null
  successUrl?: string | null
  cancelUrl?: string | null
  trialDays?: number | "Infinity" | "-Infinity" | "NaN" | null
}

応答

200 物体 application/json

{
  url: string
  source: "better-auth"
}

400 BillingBadRequestEncoded application/json

BillingBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baCheckout

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingBaCheckoutInput
const result = await client.billing.baCheckout({
  plan: "",
  successUrl: "",
  cancelUrl: "",
  trialDays: 0
})

curl

POST /api/better-auth-ストライプ/サブスクリプション

curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

置く /api/better-auth-stripe/subscription # billing.baUpdate

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  newPlan?: string | null
}

応答

200 物体 application/json

{
  success: true
  message: string
  source: "better-auth"
}

400 BillingBadRequestEncoded application/json

BillingBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baUpdate

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingBaUpdateInput
const result = await client.billing.baUpdate({
  newPlan: ""
})

curl

PUT /api/better-auth-ストライプ/サブスクリプション

curl --request PUT "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

消去 /api/better-auth-stripe/subscription # billing.baCancel

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  success: true
  message: string
  source: "better-auth"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baCancel

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.billing.baCancel()

curl

/api/better-auth-ストライプ/サブスクリプションを削除します

curl --request DELETE "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/better-auth-stripe/billing-portal

役職 /api/better-auth-stripe/billing-portal # billing.baPortal

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  returnUrl?: string | null
}

応答

200 物体 application/json

{
  url: string
  source: "better-auth"
}

400 BillingBadRequestEncoded application/json

BillingBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baPortal

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingBaPortalInput
const result = await client.billing.baPortal({
  returnUrl: ""
})

curl

POST /api/better-auth-stripe/billing-portal

curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/billing-portal" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

/api/better-auth-stripe/feature-access

役職 /api/better-auth-stripe/feature-access # billing.baFeature

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  feature?: string | null
  features?: unknown | null
}

応答

200 物体 application/json

{
  feature?: string | null
  hasAccess?: boolean | null
  source: "better-auth"
  features?: Array<{
    feature: string
    hasAccess: boolean
    error?: string | null
  }> | null
}

400 BillingBadRequestEncoded application/json

BillingBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baFeature

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingBaFeatureInput
const result = await client.billing.baFeature({
  feature: "",
  features: null
})

curl

POST /api/better-auth-ストライプ/機能アクセス

curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/feature-access" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

/api/better-auth-stripe/sync

役職 /api/better-auth-stripe/sync # billing.baSync

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  success: true
  message: string
  subscription: {
    id?: string | null
    plan: string
    status: string
    currentPeriodEnd: string | null
    cancelAtPeriodEnd: boolean
    stripeCustomerId?: string | null
    stripeSubscriptionId?: string | null
    source: "better-auth"
  } | null
  source: "better-auth"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 BillingFailureEncoded application/json

BillingFailureEncoded

SDKの例

billing.baSync

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.billing.baSync()

curl

POST /api/better-auth-ストライプ/sync

curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/sync" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/cron/update-expired-trials

得る /api/cron/update-expired-trials # billing.cronGet

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
秘密	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  success: true
  updatedCount: number | "Infinity" | "-Infinity" | "NaN"
  message: string
  timestamp: string
}

401 CronUnauthorizedEncoded |不正にエンコードされた application/json

CronUnauthorizedEncoded | UnauthorizedEncoded

500 CronFailureEncoded application/json

CronFailureEncoded

応答例捕獲 · 200

GET /api/cron/update-expired-trials

{
  "success": true,
  "updatedCount": 0,
  "message": "Successfully updated 0 expired trials",
  "timestamp": "2026-10-15T04:52:23.475Z"
}

SDKの例

billing.cronGet

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingCronGetInput
const result = await client.billing.cronGet({})

curl

GET /api/cron/update-expired-trials

curl --request GET "${CADCAMFUN_URL}/api/cron/update-expired-trials" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

秘密 クエリ

役職 /api/cron/update-expired-trials # billing.cronPost

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
秘密	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  success: true
  updatedCount: number | "Infinity" | "-Infinity" | "NaN"
  message: string
  timestamp: string
}

401 CronUnauthorizedEncoded |不正にエンコードされた application/json

CronUnauthorizedEncoded | UnauthorizedEncoded

500 CronFailureEncoded application/json

CronFailureEncoded

SDKの例

billing.cronPost

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// BillingCronPostInput
const result = await client.billing.cronPost({})

curl

POST /api/cron/update-expired-trials

curl --request POST "${CADCAMFUN_URL}/api/cron/update-expired-trials" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

秘密 クエリ

/api/health/stripe

得る /api/health/stripe # billing.stripeHealth

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  status: "healthy"
  message: string
  timestamp: string
  service: "stripe"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

503 StripeUnhealthyEncoded application/json

StripeUnhealthyEncoded

応答例捕獲 · 503

/api/health/ストライプを取得する

{
  "_tag": "StripeUnhealthy",
  "status": "unhealthy",
  "message": "Stripe is not configured on this installation",
  "timestamp": "2026-10-15T04:52:23.476Z",
  "service": "stripe"
}

SDKの例

billing.stripeHealth

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.billing.stripeHealth()

curl

/api/health/ストライプを取得する

curl --request GET "${CADCAMFUN_URL}/api/health/stripe" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/webhooks/stripe

役職 /api/webhooks/stripe # billing.stripeWebhook

必要 Authorization: Bearer <token>.

リクエストボディ · 必須 · application/octet-stream

string

応答

200 物体 application/json

{
  received: true
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

例を取得する

billing.stripeWebhook

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/webhooks/stripe`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

POST /api/webhooks/ストライプ

curl --request POST "${CADCAMFUN_URL}/api/webhooks/stripe" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/octet-stream" \
  --data-binary @request-body

試してみてください

この操作は application/octet-stream を受け取ります。 curl または fetch の例を使用します。

スキーマ

このグループのパラメータ、本体、および応答から到達可能な名前付きスキーマ。あ ? オプションのフィールドをマークします。 | null null 値が存在する可能性があるフィールドにマークを付けます。

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

BillingBadRequestEncoded

{
  _tag: "BillingBadRequest"
  error: string
}

BillingFailureEncoded

{
  _tag: "BillingFailure"
  error: string
}

BillingForbiddenEncoded

{
  _tag: "BillingForbidden"
  error: string
}

BillingNotFoundEncoded

{
  _tag: "BillingNotFound"
  error: string
}

CronFailureEncoded

{
  _tag: "CronFailure"
  success: false
  error: string
  timestamp: string
}

CronUnauthorizedEncoded

{
  _tag: "CronUnauthorized"
  error: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

StripeUnhealthyEncoded

{
  _tag: "StripeUnhealthy"
  status: "unhealthy"
  message: string
  timestamp: string
  service: "stripe"
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

このグループに電話をかける

オペレーション ID の形式は次のとおりです。 billing.<name>。生成された Promise SDK (@cadcamfun/api/sdk) それらのほとんどを次のように公開します client.<namespace>.<method>(input)、どこ input パスパラメータとボディフィールドの 1 つのフラットオブジェクトです。各カードの SDK の例は、正確なアクセサーと入力タイプを示しています。マルチパートアップロード、バイナリまたは JavaScript 応答、生の Webhook は生成されません。それらのカードが示しているのは fetch 代わりに。

Promise SDK からのエラー

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

トラブルシューティング

症状	考えられる原因	修理
呼び出しごとの 401	以前の起動からのトークン、または欠落しています `Bearer` 接頭辞	送信 `Authorization: Bearer <token>` サイドカーが開始されたトークンを使用します。
何も起きる前の 400	本体またはパラメータがスキーマと一致しません	ペイロードとカード上のリクエストスキーマを比較します。
別の場所で見えるレコードの 403 または 404	代理アカウントは異なります	権利を送信します `x-session-token`、またはレコードを所有するローカルプロファイルを使用します。
409	重複した名前や古いブランチヘッドなどの矛盾した状態	リソースを再読み込みし、現在のデータで再試行します。
「CORS によってブロックされました」と表示されてみてください	ドキュメントは非ループバックオリジンから提供されます	ドキュメントをローカルで実行するか、リクエストをcurlとしてコピーします。
接続拒否	サイドカーが新しいポートで再起動されました	新しいポートからポートを読み取ります `ready` 行。