Documentación
Facturación
Información de suscripción, integración del portal/pago de Stripe, mantenimiento de prueba e ingesta de webhooks firmados.
Traducido automáticamente del inglés. Ver el original en inglés
Envíe estas solicitudes a su propio sidecar en funcionamiento. Los valores permanecen en este navegador.
¿Cómo funciona esto?
El sidecar escucha en un puerto loopback elegido al inicio y lo imprime en su ready línea; use esa URL y el CADCAMFUN_TOKEN se empezó con. Las solicitudes van directamente desde esta página a esa dirección.
El sidecar envía encabezados CORS solo a los orígenes Tauri y a http://localhost o http://127.0.0.1 en cualquier puerto. Desde los documentos alojados, el navegador bloquea la respuesta, así que ejecute los documentos localmente (bun run dev en packages/web) para usar el área de juegos o copiar la solicitud como curl. Para experimentar sin tocar datos reales, inicie el sidecar con CADCAMFUN_DATA_DIR apuntado a un directorio desechable - ver el tutorial de la API.
Operaciones
15 endpoints en el billing grupo, generado a partir del propio sidecar Documento OpenAPI. Las operaciones protegidas toman Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticación. El comportamiento y los límites están en la guía del subsistema.
| conseguir | /api/subscription/info | billing.info |
| conseguir | /api/subscriptions | billing.current |
| correo | /api/subscriptions | billing.subscribe |
| correo | /api/subscriptions/portal | billing.portal |
| conseguir | /api/better-auth-stripe/subscription | billing.baGet |
| correo | /api/better-auth-stripe/subscription | billing.baCheckout |
| poner | /api/better-auth-stripe/subscription | billing.baUpdate |
| borrar | /api/better-auth-stripe/subscription | billing.baCancel |
| correo | /api/better-auth-stripe/billing-portal | billing.baPortal |
| correo | /api/better-auth-stripe/feature-access | billing.baFeature |
| correo | /api/better-auth-stripe/sync | billing.baSync |
| conseguir | /api/cron/update-expired-trials | billing.cronGet |
| correo | /api/cron/update-expired-trials | billing.cronPost |
| conseguir | /api/health/stripe | billing.stripeHealth |
| correo | /api/webhooks/stripe | billing.stripeWebhook |
/api/subscription/info
billing.info Requiere Authorization: Bearer <token>.
| Nombre | En | Tipo | Requerido |
|---|---|---|---|
| userId | consulta | cadena | null | opcional |
200 objeto 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
Ejemplo de respuesta capturado · 400
{
"_tag": "BillingBadRequest",
"error": "User ID is required"
} Ejemplo de 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}" Pruébalo
/api/subscriptions
billing.current Requiere Authorization: Bearer <token>.
200 objeto 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
Ejemplo de respuesta capturado · 200
{
"plan": "FREE",
"status": "active",
"periodEnd": null,
"cancelAtPeriodEnd": false
} Ejemplo de 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}" Pruébalo
billing.subscribe Requiere Authorization: Bearer <token>.
{ priceId?: string | null startTrial?: boolean | null }
200 objeto 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
Ejemplo de 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 Pruébalo
/api/subscriptions/portal
billing.portal Requiere Authorization: Bearer <token>.
{ returnUrl?: string | null }
200 objeto application/json
{ url: string }
400 BadRequestEncoded application/json
BadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
404 NotFoundEncoded application/json
NotFoundEncoded
500 InternalErrorEncoded application/json
InternalErrorEncoded
Ejemplo de 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 Pruébalo
/api/better-auth-stripe/subscription
billing.baGet Requiere Authorization: Bearer <token>.
200 objeto 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
Ejemplo de respuesta capturado · 200
{
"id": "c942817d-0162-4291-84ff-77321d387acc",
"plan": "FREE",
"status": "active",
"currentPeriodEnd": null,
"cancelAtPeriodEnd": false,
"stripeCustomerId": null,
"stripeSubscriptionId": null,
"source": "better-auth"
} Ejemplo de 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}" Pruébalo
billing.baCheckout Requiere Authorization: Bearer <token>.
{ plan?: string | null successUrl?: string | null cancelUrl?: string | null trialDays?: number | "Infinity" | "-Infinity" | "NaN" | null }
200 objeto application/json
{ url: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Ejemplo de 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 Pruébalo
billing.baUpdate Requiere Authorization: Bearer <token>.
{ newPlan?: string | null }
200 objeto application/json
{ success: true message: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Ejemplo de 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 Pruébalo
billing.baCancel Requiere Authorization: Bearer <token>.
200 objeto application/json
{ success: true message: string source: "better-auth" }
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Ejemplo de 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}" Pruébalo
/api/better-auth-stripe/billing-portal
billing.baPortal Requiere Authorization: Bearer <token>.
{ returnUrl?: string | null }
200 objeto application/json
{ url: string source: "better-auth" }
400 BillingBadRequestEncoded application/json
BillingBadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
500 BillingFailureEncoded application/json
BillingFailureEncoded
Ejemplo de 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 Pruébalo
/api/better-auth-stripe/feature-access
billing.baFeature Requiere Authorization: Bearer <token>.
{ feature?: string | null features?: unknown | null }
200 objeto 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
Ejemplo de 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 Pruébalo
/api/better-auth-stripe/sync
billing.baSync Requiere Authorization: Bearer <token>.
200 objeto 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
Ejemplo de 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}" Pruébalo
/api/cron/update-expired-trials
billing.cronGet Requiere Authorization: Bearer <token>.
| Nombre | En | Tipo | Requerido |
|---|---|---|---|
| secreto | consulta | cadena | null | opcional |
200 objeto application/json
{ success: true updatedCount: number | "Infinity" | "-Infinity" | "NaN" message: string timestamp: string }
401 CronNo autorizadoEncodificado | No autorizadoCodificado application/json
CronUnauthorizedEncoded | UnauthorizedEncoded
500 CronFailureEncoded application/json
CronFailureEncoded
Ejemplo de respuesta capturado · 200
{
"success": true,
"updatedCount": 0,
"message": "Successfully updated 0 expired trials",
"timestamp": "2026-10-15T04:52:23.475Z"
} Ejemplo de 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}" Pruébalo
billing.cronPost Requiere Authorization: Bearer <token>.
| Nombre | En | Tipo | Requerido |
|---|---|---|---|
| secreto | consulta | cadena | null | opcional |
200 objeto application/json
{ success: true updatedCount: number | "Infinity" | "-Infinity" | "NaN" message: string timestamp: string }
401 CronNo autorizadoEncodificado | No autorizadoCodificado application/json
CronUnauthorizedEncoded | UnauthorizedEncoded
500 CronFailureEncoded application/json
CronFailureEncoded
Ejemplo de 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}" Pruébalo
/api/health/stripe
billing.stripeHealth Requiere Authorization: Bearer <token>.
200 objeto application/json
{ status: "healthy" message: string timestamp: string service: "stripe" }
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
503 StripeUnhealthyEncoded application/json
StripeUnhealthyEncoded
Ejemplo de respuesta capturado · 503
{
"_tag": "StripeUnhealthy",
"status": "unhealthy",
"message": "Stripe is not configured on this installation",
"timestamp": "2026-10-15T04:52:23.476Z",
"service": "stripe"
} Ejemplo de 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}" Pruébalo
/api/webhooks/stripe
billing.stripeWebhook Requiere Authorization: Bearer <token>.
string 200 objeto application/json
{ received: true }
400 BadRequestEncoded application/json
BadRequestEncoded
401 UnauthorizedEncoded application/json
UnauthorizedEncoded
buscar ejemplo
// 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 Pruébalo
Esta operación requiere aplicación/flujo de octetos; Utilice el ejemplo curl o fetch.
esquemas
Esquemas con nombre accesibles desde los parámetros, cuerpos y respuestas de este grupo. A ? marca un campo opcional; | null marca un campo que puede estar presente con un valor nulo.
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" }
Llamando a este grupo
Los identificadores de operación tienen la forma billing.<name>. El SDK de promesa generado (@cadcamfun/api/sdk) expone la mayoría de ellos como client.<namespace>.<method>(input), dónde input es un objeto plano de parámetros de ruta y campos de cuerpo; El ejemplo de SDK de cada tarjeta muestra el acceso exacto y el tipo de entrada. No se generan cargas de varias partes, respuestas binarias o JavaScript ni webhooks sin formato; esas tarjetas muestran fetch en su lugar.
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
}
} Solución de problemas
| Síntoma | causa probable | Arreglar |
|---|---|---|
| 401 en cada llamada | Token de un lanzamiento anterior o faltante Bearer prefijo | Enviar Authorization: Bearer <token> con la ficha con la que se inició el sidecar. |
| 400 antes de que ocurra algo | El cuerpo o el parámetro no coincide con el esquema | Compare la carga útil con el esquema de solicitud en la tarjeta. |
| 403 o 404 en un registro que puedes ver en otro sitio | La cuenta de actuación difiere. | enviar la derecha x-session-tokeno utilice el perfil local propietario del registro. |
| 409 | Estado conflictivo, como un nombre duplicado o un encabezado de sucursal obsoleto | Vuelva a leer el recurso y vuelva a intentarlo con los datos actuales. |
| Pruébelo, dice "bloqueado por CORS" | Los documentos se entregan desde un origen sin bucle invertido. | Ejecute los documentos localmente o copie la solicitud como curl. |
| Conexión rechazada | El sidecar se reinició en un nuevo puerto. | Leer el puerto del nuevo ready línea. |