Taxarea creditelor

​

Prezentare generală

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 — taxe fixe și per membru pe care platforma le aplică pentru dvs., o dată per perioadă de facturare.
• operations — pentru ce taxați pe măsură ce este utilizat, dintr-o funcție logică.
• description — un rând prietenos afișat cumpărătorilor în listarea dvs. din marketplace.

​

Taxe recurente

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',
    },
  },
},

• O dată per perioadă de facturare a spațiului de lucru, la propria limită de perioadă a spațiului de lucru, nu în prima zi a lunii.
• Nu sunt proporționale. O aplicație instalată la mijlocul perioadei este taxată cu suma integrală pentru acea perioadă; dezinstalarea oprește perioada următoare, nu rambursează perioada curentă.
• Taxele per membru iau în calcul toți membrii spațiului de lucru în momentul în care este aplicată taxa, astfel încât un spațiu de lucru care crește la mijlocul perioadei plătește numărul mai mare începând cu perioada următoare.
• Doar pentru abonamente lunare. Un spațiu de lucru cu un plan anual nu este taxat cu o taxă MONTH, în loc să fie taxat o dată pentru întregul an.
• Limitate. Un tarif declarat peste $100 sau o taxă per membru al cărei tarif, înmulțit cu numărul de membri, ar depăși $1.000 pentru perioadă sunt refuzate și nu sunt percepute. Platforma aplică singură aceste taxe, astfel încât nu va înregistra un debit pe care nu îl poate justifica.

​

Operațiuni facturabile

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

​

Taxare

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

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

• Declararea operațiunilor permite ca Utilizare să împartă cheltuiala aplicației dvs. în funcție de ceea ce a taxat. O aplicație care nu declară nimic este totuși raportată, ca o singură secțiune sub numele său afișat.
• Taxarea unei operațiuni pe care manifestul dvs. nu o declară este respinsă. Adăugați-o la billing.operations și sincronizați.
• Mai multe operațiuni pot partaja un singur operationType. Două operațiuni de îmbogățire contorizate ambele ca CODE_EXECUTION sunt în continuare afișate ca două secțiuni etichetate.
• Fără operation, numiți direct categoria de facturare cu operationType, opțional cu un resourceContext în formă liberă. Cele două forme se exclud reciproc: operation conține eticheta, operationType nu.
• Taxarea nu face niciodată ca funcția dvs. să eșueze. O eroare de facturare este înregistrată și ignorată, iar apelul nu face nimic în afara mediului de rulare al funcției logice, astfel încât rulările locale și testele să nu se blocheze.

​

Verificarea înainte de a cheltui

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

const { hasAvailableCredits } = await getCreditAvailability();

if (!hasAvailableCredits) {
  return;
}

• Indică dacă aplicația dvs. poate cheltui în acest spațiu de lucru, nu cât a mai rămas. Aplicația dvs. nu vede soldul, planul sau limitele acestuia.
• Eșuează deschis. Dacă verificarea expiră sau serverul nu poate fi accesat, raportează că există credite disponibile, astfel încât o problemă de infrastructură să nu oprească aplicația dvs. Tratați-l ca pe un indiciu care merită respectat, nu ca pe o decizie de autorizare.
• Este o instantanee. Creditele se pot epuiza între verificare și lucrare — inclusiv din cauza propriilor debitări, deoarece fiecare debitare pe care o efectuați modifică același contor pe care îl citește acesta.
• Restricția nu este aplicată uniform. Nu toate căile de e-mail de ieșire sunt condiționate de credite, astfel că un false aici vă indică faptul că aplicația dvs. nu ar trebui să cheltuiască acum, în loc să prezică exact care apeluri vor eșua.

​

Informarea utilizatorilor despre costuri

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

​

Atribuire

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