Cobro de Créditos

​

Resumen

import { defineApplication } from 'twenty-sdk/define';

export default defineApplication({
  // ...identity, variables...
  billing: {
    description: '$20/month + $0.02 per minute recorded',
    recurring: {
      platformFee: {
        period: 'MONTH',
        amountMicroCredits: 20_000_000,
        label: 'Platform fee',
      },
    },
    operations: {
      recordMeeting: {
        operationType: 'CALL_RECORDING',
        label: 'Meeting recording',
      },
    },
  },
});

• recurring — tarifas fijas y por miembro que la plataforma cobra por ti, una vez por período de facturación.
• operations — aquello por lo que cobras a medida que lo usas, desde una función lógica.
• description — una línea clara que se muestra a los compradores en tu ficha del marketplace.

​

Cargos recurrentes

billing: {
  recurring: {
    platformFee: {
      period: 'MONTH',
      amountMicroCredits: 20_000_000,
      label: 'Platform fee',
    },
    seat: {
      period: 'MONTH',
      amountMicroCredits: 5_000_000,
      per: 'WORKSPACE_MEMBER',
      label: 'Per member',
    },
  },
},

• Una vez por período de facturación del espacio de trabajo, en el límite de período propio del espacio de trabajo, no el primer día del mes.
• No se prorratean. A una app instalada a mitad de período se le cobra el importe completo de ese período; al desinstalarla se detiene el siguiente período, pero no se reembolsa el actual.
• Los cargos por miembro cuentan a todos los miembros del espacio de trabajo en el momento en que se cobra el cargo, por lo que un espacio de trabajo que crece a mitad de período paga el recuento mayor a partir del siguiente período.
• Solo en suscripciones mensuales. A un espacio de trabajo con un plan anual no se le cobra una tarifa MONTH, en lugar de cobrarle una vez por todo el año.
• Limitados. Se rechaza y no se aumenta una tarifa declarada superior a $100, o un cargo por miembro cuya tarifa multiplicada por el número de miembros superaría $1.000 durante el período. La propia plataforma cobra estos cargos, por lo que no registrará un débito que no pueda justificar.

​

Operaciones facturables

billing: {
  operations: {
    recordMeeting: {
      operationType: 'CALL_RECORDING',
      label: 'Meeting recording',
    },
    summarizeMeeting: {
      operationType: 'AI_CHAT_TOKEN',
      label: 'Meeting summary',
    },
  },
},

​

Cobro

import { chargeCredits } from 'twenty-sdk/billing';

await chargeCredits({
  operation: 'recordMeeting',
  creditsUsedMicro: 250_000,
  quantity: 12,
});

• Declarar operaciones permite que Uso divida el gasto de tu app según aquello por lo que cobró. Una app que no declara nada se sigue informando como una sola sección bajo su nombre visible.
• Se rechaza el cobro de una operación que tu manifiesto no declara. Añádela a billing.operations y sincroniza.
• Varias operaciones pueden compartir un mismo operationType. Dos operaciones de enriquecimiento medidas ambas como CODE_EXECUTION siguen mostrándose como dos secciones con etiqueta.
• Sin operation, nombra directamente la categoría de facturación con operationType, opcionalmente con un resourceContext de formato libre. Las dos formas son mutuamente excluyentes: operation incluye la etiqueta; operationType, no.
• El cobro nunca hace que falle tu función. Se registra y se descarta un error de facturación, y la llamada no realiza ninguna operación fuera del tiempo de ejecución de la función lógica para que las ejecuciones locales y las pruebas no fallen.

​

Comprobar antes de gastar

import { getCreditAvailability } from 'twenty-sdk/billing';

const { hasAvailableCredits } = await getCreditAvailability();

if (!hasAvailableCredits) {
  return;
}

• Indica si tu aplicación puede gastar en este espacio de trabajo, no cuánto le queda. Tu aplicación no ve el saldo, el plan ni sus límites.
• Falla de forma abierta. Si la comprobación agota el tiempo de espera o el servidor es inaccesible, informa que hay créditos disponibles, para que un problema de infraestructura no detenga tu app. Trátalo como una indicación que vale la pena respetar, no como una decisión de autorización.
• Es una instantánea. Los créditos pueden agotarse entre la comprobación y el trabajo, incluso debido a tus propios cargos, ya que cada cargo que haces mueve el mismo contador que lee esto.
• La restricción no se aplica de manera uniforme. No todas las rutas de correo electrónico saliente están restringidas por créditos, por lo que un false aquí te indica que tu aplicación no debe gastar en este momento, en lugar de predecir exactamente qué llamadas fallarán.

​

Indicar a las personas cuánto cuesta

billing: {
  description: '$0.02 per minute recorded, billed to your Twenty credits',
},

​

Atribución

await chargeCredits({
  operation: 'recordMeeting',
  creditsUsedMicro: 250_000,
  quantity: 12,
  userWorkspaceId: ownerUserWorkspaceId,
});