Addebito dei Crediti

​

Panoramica

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 — tariffe fisse e per membro che la piattaforma applica per te, una volta per periodo di fatturazione.
• operations — ciò per cui addebiti durante l’utilizzo, da una funzione di logica.
• description — una riga descrittiva visualizzata agli acquirenti nella scheda della tua app sul marketplace.

​

Addebiti ricorrenti

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 volta per periodo di fatturazione del workspace, alla scadenza del periodo del workspace stesso, non il primo giorno del mese.
• Non proporzionati. A un’app installata a metà periodo viene addebitato l’intero importo per quel periodo; la disinstallazione interrompe il periodo successivo, ma non rimborsa quello corrente.
• Gli addebiti per membro conteggiano tutti i membri del workspace nel momento in cui viene applicato l’addebito, quindi un workspace che cresce a metà periodo paga il conteggio più alto a partire dal periodo successivo.
• Solo per gli abbonamenti mensili. A un workspace con piano annuale non viene addebitata una tariffa MONTH, anziché essere addebitato una volta per l’intero anno.
• Limitati. Una tariffa dichiarata superiore a $100, o un addebito per membro la cui tariffa moltiplicata per il numero di membri supererebbe $1.000 per il periodo, viene rifiutata e non viene aumentata. La piattaforma applica questi addebiti autonomamente, quindi non registrerà un addebito che non può giustificare.

​

Operazioni fatturabili

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

​

Addebito

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

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

• La dichiarazione delle operazioni consente a Utilizzo di suddividere la spesa della tua app in base a ciò per cui ha addebitato. Un’app che non dichiara nulla viene comunque riportata come un’unica sezione sotto il suo nome visualizzato.
• L’addebito di un’operazione non dichiarata dal tuo manifest viene rifiutato. Aggiungila a billing.operations e sincronizza.
• Più operazioni possono condividere uno stesso operationType. Due operazioni di arricchimento, entrambe misurate come CODE_EXECUTION, vengono comunque visualizzate come due sezioni etichettate.
• Senza operation, indica direttamente la categoria di fatturazione con operationType, facoltativamente con un resourceContext in formato libero. Le due forme si escludono a vicenda: operation contiene l’etichetta, operationType no.
• L’addebito non fa mai fallire la tua funzione. Un errore di fatturazione viene registrato e ignorato, e la chiamata non esegue alcuna operazione al di fuori del runtime della funzione di logica, affinché le esecuzioni locali e i test non si arrestino in modo anomalo.

​

Verificare prima di spendere

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

const { hasAvailableCredits } = await getCreditAvailability();

if (!hasAvailableCredits) {
  return;
}

• Indica se la tua app può spendere in questo spazio di lavoro, non quanto le rimane. La tua app non vede il saldo, il piano o i relativi limiti.
• In caso di errore, consente l’operazione. Se il controllo va in timeout o il server non è raggiungibile, segnala che i crediti sono disponibili, così un problema dell’infrastruttura non interrompe la tua app. Consideralo un suggerimento che vale la pena rispettare, non una decisione di autorizzazione.
• È un’istantanea. I crediti possono esaurirsi tra il controllo e l’operazione — anche a causa dei tuoi addebiti, poiché ogni addebito che effettui fa avanzare lo stesso contatore letto qui.
• Il controllo non viene applicato in modo uniforme. Non tutti i percorsi delle email in uscita sono vincolati dai crediti, quindi un valore false qui indica che la tua app non dovrebbe spendere in questo momento, anziché prevedere esattamente quali chiamate avranno esito negativo.

​

Informare le persone sui costi

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

​

Attribuzione

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