Tearleads

OrganizationBillingHistoryEntry

One recorded billing event of an organization. Amounts are in the currency's minor unit as the provider reported them.

Shape

object

24 fields
  • idstringrequired
  • categorystringrequired
    • one of lifecycle, seat, invoice
  • providerstringrequired
    • one of revenuecat, stripe, internal
  • environmentstringrequirednullable
    • one of sandbox, production
  • eventTypestringrequired
  • outcomestringrequired
    • one of applied, ignored
  • occurredAtstringrequired
  • productIdstringrequirednullable
  • transactionIdstringrequirednullable
  • invoiceIdstringrequirednullable
  • subscriptionIdstringrequirednullable
  • billingReasonstringrequirednullable
  • seatCountintegerrequirednullable
    • at least 0
  • seatDeltaintegerrequirednullable

    Change in seats this event caused; negative for a reduction.

  • activeSeatCountintegerrequirednullable
    • at least 0
  • priceIdstringrequirednullable
  • unitAmountintegerrequirednullable
    • at least 0

    Price per billing period; for a recognized native grant, its canonical monthly USD list price.

  • currencystringrequirednullable
  • intervalstringrequirednullable
  • intervalCountintegerrequirednullable
    • at least 1
  • totalAmountintegerrequirednullable
    • at least 0

    Amount actually charged, in totalCurrency.

  • totalCurrencystringrequirednullable
  • periodStartsAtstringrequirednullable
  • periodEndsAtstringrequirednullable

Other fields are allowed.

Used by

Schemas