Credit

Credit management APIs

The Credit API provides methods for managing credits in the Elements platform. Credits are the billing unit used to pay for computations and data access.

Credit Concepts

  • Available - Credits that can be used for future Analyses and Computations
  • Reserved - Credits on hold for running Analyses and Computations
  • Used - Credits consumed by past Analyses and Computations

Available Methods

MethodDescription
credit.summary()Get credit summary for a department
credit.estimate()Estimate credits required for a computation
credit.transactions()Get detailed transaction history
credit.add()Add credits to a credit source (admin)
credit.remove()Remove credits from a credit source (admin)
credit.refund()Refund credits to a user collection (admin)