Documentazione
Fatturazione
Informazioni sull'abbonamento, integrazione del portale/checkout Stripe, manutenzione di prova e acquisizione di webhook firmati.
Tradotto automaticamente dall'inglese. Vedi l'originale in inglese
Invia queste richieste al tuo sidecar in corsa. I valori rimangono in questo browser.
Come funziona
Il sidecar resta in ascolto su una porta di loopback scelta all'avvio e la stampa nel suo file ready linea; usa quell'URL e il file CADCAMFUN_TOKEN è stato iniziato con. Le richieste vanno direttamente da questa pagina a quell'indirizzo.
Il sidecar invia intestazioni CORS solo alle origini Tauri e a http://localhost o http://127.0.0.1 su qualsiasi porto. Dai documenti ospitati il browser blocca la risposta, quindi esegui i documenti localmente (bun run dev in packages/web) per utilizzare il parco giochi, oppure copiare la richiesta come ricciolo. Per sperimentare senza toccare i dati reali, avvia il sidecar con CADCAMFUN_DATA_DIR indicato in una directory usa e getta - vedi la procedura dettagliata dell'API.
Operazioni
15 endpoint nel billing gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.
| ottenere | /api/subscription/info | billing.info |
| ottenere | /api/subscriptions | billing.current |
| inviare | /api/subscriptions | billing.subscribe |
| inviare | /api/subscriptions/portal | billing.portal |
| ottenere | /api/better-auth-stripe/subscription | billing.baGet |
| inviare | /api/better-auth-stripe/subscription | billing.baCheckout |
| mettere | /api/better-auth-stripe/subscription | billing.baUpdate |
| eliminare | /api/better-auth-stripe/subscription | billing.baCancel |
| inviare | /api/better-auth-stripe/billing-portal | billing.baPortal |
| inviare | /api/better-auth-stripe/feature-access | billing.baFeature |
| inviare | /api/better-auth-stripe/sync | billing.baSync |
| ottenere | /api/cron/update-expired-trials | billing.cronGet |
| inviare | /api/cron/update-expired-trials | billing.cronPost |
| ottenere | /api/health/stripe | billing.stripeHealth |
| inviare | /api/webhooks/stripe | billing.stripeWebhook |
/api/subscription/info
billing.info Richiede Authorization: Bearer <token>.
| Nome | In | Tipo | Necessario |
|---|---|---|---|
| userId | domanda | corda | null | opzionale |
200 oggetto 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
Risposta di esempio catturato · 400
{
"_tag": "BillingBadRequest",
"error": "User ID is required"
} Esempio dell'SDK
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
curl --request GET "${CADCAMFUN_URL}/api/subscription/info" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
/api/subscriptions
billing.current Richiede Authorization: Bearer <token>.
200 oggetto 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
Risposta di esempio catturato · 200
{
"plan": "FREE",
"status": "active",
"periodEnd": null,
"cancelAtPeriodEnd": false
} Esempio dell'SDK
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
curl --request GET "${CADCAMFUN_URL}/api/subscriptions" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
billing.subscribe Richiede Authorization: Bearer <token>.
{ priceId?: string | null startTrial?: boolean | null }
200 oggetto 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
Esempio dell'SDK
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
curl --request POST "${CADCAMFUN_URL}/api/subscriptions" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
--header "Content-Type: application/json" \
--data-binary @request.json Provalo
/api/subscriptions/portal
billing.portal Richiede Authorization: Bearer <token>.
{ returnUrl?: string | null }
200 oggetto application/json
{ url: string }
400 BadRequestEncoded application/json
BadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
404 NotFoundEncoded application/json
NotFoundEncoded
500 InternalErrorEncoded application/json
InternalErrorEncoded
Esempio dell'SDK
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
curl --request POST "${CADCAMFUN_URL}/api/subscriptions/portal" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
--header "Content-Type: application/json" \
--data-binary @request.json Provalo
/api/better-auth-stripe/subscription
billing.baGet Richiede Authorization: Bearer <token>.
200 oggetto 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
Risposta di esempio catturato · 200
{
"id": "c942817d-0162-4291-84ff-77321d387acc",
"plan": "FREE",
"status": "active",
"currentPeriodEnd": null,
"cancelAtPeriodEnd": false,
"stripeCustomerId": null,
"stripeSubscriptionId": null,
"source": "better-auth"
} Esempio dell'SDK
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
curl --request GET "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
billing.baCheckout Richiede Authorization: Bearer <token>.
{ plan?: string | null successUrl?: string | null cancelUrl?: string | null trialDays?: number | "Infinity" | "-Infinity" | "NaN" | null }
200 oggetto application/json
{ url: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Esempio dell'SDK
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
curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
--header "Content-Type: application/json" \
--data-binary @request.json Provalo
billing.baUpdate Richiede Authorization: Bearer <token>.
{ newPlan?: string | null }
200 oggetto application/json
{ success: true message: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Esempio dell'SDK
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
curl --request PUT "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
--header "Content-Type: application/json" \
--data-binary @request.json Provalo
billing.baCancel Richiede Authorization: Bearer <token>.
200 oggetto application/json
{ success: true message: string source: "better-auth" }
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Esempio dell'SDK
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
curl --request DELETE "${CADCAMFUN_URL}/api/better-auth-stripe/subscription" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
/api/better-auth-stripe/billing-portal
billing.baPortal Richiede Authorization: Bearer <token>.
{ returnUrl?: string | null }
200 oggetto application/json
{ url: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Esempio dell'SDK
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
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 Provalo
/api/better-auth-stripe/feature-access
billing.baFeature Richiede Authorization: Bearer <token>.
{ feature?: string | null features?: unknown | null }
200 oggetto 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
Esempio dell'SDK
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
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 Provalo
/api/better-auth-stripe/sync
billing.baSync Richiede Authorization: Bearer <token>.
200 oggetto 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
Esempio dell'SDK
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
curl --request POST "${CADCAMFUN_URL}/api/better-auth-stripe/sync" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
/api/cron/update-expired-trials
billing.cronGet Richiede Authorization: Bearer <token>.
| Nome | In | Tipo | Necessario |
|---|---|---|---|
| segreto | domanda | corda | null | opzionale |
200 oggetto application/json
{ success: true updatedCount: number | "Infinity" | "-Infinity" | "NaN" message: string timestamp: string }
401 CronUnauthorizedEncoded | NonautorizzatoCodificato application/json
CronUnauthorizedEncoded | UnauthorizedEncoded
500 CronFailureEncoded application/json
CronFailureEncoded
Risposta di esempio catturato · 200
{
"success": true,
"updatedCount": 0,
"message": "Successfully updated 0 expired trials",
"timestamp": "2026-10-15T04:52:23.475Z"
} Esempio dell'SDK
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
curl --request GET "${CADCAMFUN_URL}/api/cron/update-expired-trials" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
billing.cronPost Richiede Authorization: Bearer <token>.
| Nome | In | Tipo | Necessario |
|---|---|---|---|
| segreto | domanda | corda | null | opzionale |
200 oggetto application/json
{ success: true updatedCount: number | "Infinity" | "-Infinity" | "NaN" message: string timestamp: string }
401 CronUnauthorizedEncoded | NonautorizzatoCodificato application/json
CronUnauthorizedEncoded | UnauthorizedEncoded
500 CronFailureEncoded application/json
CronFailureEncoded
Esempio dell'SDK
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
curl --request POST "${CADCAMFUN_URL}/api/cron/update-expired-trials" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
/api/health/stripe
billing.stripeHealth Richiede Authorization: Bearer <token>.
200 oggetto application/json
{ status: "healthy" message: string timestamp: string service: "stripe" }
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
503 StripeUnhealthyEncoded application/json
StripeUnhealthyEncoded
Risposta di esempio catturato · 503
{
"_tag": "StripeUnhealthy",
"status": "unhealthy",
"message": "Stripe is not configured on this installation",
"timestamp": "2026-10-15T04:52:23.476Z",
"service": "stripe"
} Esempio dell'SDK
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
curl --request GET "${CADCAMFUN_URL}/api/health/stripe" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" Provalo
/api/webhooks/stripe
billing.stripeWebhook Richiede Authorization: Bearer <token>.
string 200 oggetto application/json
{ received: true }
400 BadRequestEncoded application/json
BadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
prendere esempio
// 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
curl --request POST "${CADCAMFUN_URL}/api/webhooks/stripe" \
--header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
--header "Content-Type: application/octet-stream" \
--data-binary @request-body Provalo
Questa operazione richiede application/octet-stream; usa l'esempio curl o fetch.
Schemi
Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.
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 }
InternalErrorEncoded{ _tag: "InternalError" message: string }
NotFoundEncoded{ _tag: "NotFound" message: string }
StripeUnhealthyEncoded{ _tag: "StripeUnhealthy" status: "unhealthy" message: string timestamp: string service: "stripe" }
Chiamando questo gruppo
Gli ID operazione hanno il formato billing.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.
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
}
} Risoluzione dei problemi
| Sintomo | Probabile causa | Aggiustare |
|---|---|---|
| 401 a ogni chiamata | Token di un lancio precedente o mancante Bearer prefisso | Inviare Authorization: Bearer <token> con il gettone con cui è stato avviato il sidecar. |
| 400 prima che accada qualcosa | Il corpo o il parametro non corrisponde allo schema | Confronta il payload con lo schema di richiesta sulla carta. |
| 403 o 404 su un record visibile altrove | Il resoconto della recitazione è diverso | Invia il diritto x-session-tokenoppure utilizzare il profilo locale proprietario del record. |
| 409 | Stato in conflitto, ad esempio un nome duplicato o una testa di ramo obsoleta | Rileggere la risorsa e riprovare con i dati correnti. |
| Prova, dice "bloccato da CORS" | I documenti vengono serviti da un'origine non di loopback | Esegui i documenti localmente o copia la richiesta come curl. |
| Connessione rifiutata | Il sidecar è ripartito su una nuova porta | Leggi il porto dal nuovo ready riga. |