1. Docs
2. Reference
3. REST API Docs
4. Schema
5. ConsumptionUsage

ConsumptionUsage captures the unit rate and current consumption for a consumption-based product.

Properties

• totalConsumed integer required
  The total consumed
• consumed map[string]integer required
  The consumed amount
• unitRateSchema enum required
  UnitRateSchema captures which pricing plan is associated with the product subscription, and further indicates which pricing rate structure should be read.
  Values:

  graduated-v0 — GraduatedV0

  UnitRateSchemaGraduatedV0 is the initial pricing schema that we launched with the advent of our Growth plans. Pricing plan rates are pasred into UnitRateGraduatedV0.

  graduated-v1 — GraduatedV1

  UnitRateSchemaGraduated plans used graduated pricing plans, with plans parsed into UnitRateGraduatedV1. These plans are introduced starting 2025.

  graduated-v2 — GraduatedV2

  UnitRateSchemaGraduatedV2 is used for pricing plans where the free tier is handled via credit grants (dollar credits) rather than being baked into the pricing tiers. Rates are parsed into UnitRateGraduatedV2 and contain only paid (on-demand) tiers. The tiers field uses UnitRateGraduatedTier for graduated prices with multiple tiers, and a single-element tiers array for per-unit prices with only one rate tier.

• unitRateGraduatedV0 UnitRateGraduatedV0 optional
  UnitRateGraduatedV0 will be populated for UnitRateSchemaGraduatedV0 plans.
• ↳ upfrontCost integer required

  UpfrontCost is the up-front charge the customer will have paid to have an active subscription. For Team Growth this is $0, since there is no credit pre-payment and has free-tier. But for Enterprise Growth, it is usually (Rate * CreditsIncluded).

  Value is in USD cents.

• ↳ creditsIncluded integer required
  IncludedCredits is the number of resource-hours included in the subscription, e.g. the pre-paid credits or those in the “free tier”. Keep the JSON tag as “creditsIncluded” to maintain compatibility with the frontend until we consolidate product.UnitRateGraduatedV0 and apitype.UnitRateGraduatedV1.
• ↳ costPerResource string required
  PerUnitCost is a user-facing string describing the cost-per unit with the currency symbol. e.g. “$0.0005”. Keep the JSON tag as “costPerResource” to maintain compatibility with the frontend until we consolidate product.UnitRateGraduatedV0 and apitype.UnitRateGraduatedV1.
• unitRateGraduatedV1 UnitRateGraduatedV1 optional
  UnitRateGraduatedV1 will be populated for UnitRateSchemaGraduatedV1 plans.
• ↳ tiers array[UnitRateGraduatedTier] required
  The list of graduated pricing tiers.
• unitRateGraduatedV2 UnitRateGraduatedV2 optional
  UnitRateGraduatedV2 will be populated for UnitRateSchemaGraduatedV2 plans.
• ↳ tiers array[UnitRateGraduatedTier] required
  The list of on-demand pricing tiers. For graduated prices, contains multiple tiers. For per-unit prices, contains a single tier.
• statsV0 ConsumptionUsageStatsV0 optional
  StatsV0 are the usage statistics, and will be populated for graduated-v0 plans.
• ↳ includedUnits integer required
  IncludedUnits is the number of units included in the subscription.
• ↳ isIncludedUnitsFree boolean required
  IsIncludedUnitsFree indicates whether the included units are free of charge.
• ↳ onDemandRate number required
  OnDemandRate is the on-demand rate for the billing family’s total usage, in USD cents per unit.
• ↳ estimatedOnDemandCost number required
  EstimatedOnDemandCost is the estimated cost of the on-demand usage (beyond the free units), in USD cents.
• ↳ estimatedTotalCost number required
  EstimatedTotalCost is the estimated total cost of billing family’s usage for the current billing cycle, in USD cents.
• statsV1 ConsumptionUsageStatsV1 optional
  StatsV1 are the usage statistics, and will be populated for graduated-v1 plans.
• ↳ effectiveRate number required
  EffectiveRate is the effective rate for the billing family’s total usage, in USD dollar per unit.
• ↳ includedUnits integer required
  IncludedUnits is the number of units included in the subscription.
• ↳ isIncludedUnitsFree boolean required
  IsIncludedUnitsFree indicates whether the included units are free of charge.
• ↳ volumeSavingsPercentage number required
  VolumeSavingsAmount is the amount of volume savings for the billing family’s total usage, in USD dollar.
• ↳ onDemandRate number required
  OnDemandRate is the on-demand rate for the billing family’s total usage, in USD cents per unit.
• ↳ estimatedOnDemandCost number required
  EstimatedOnDemandCost is the estimated cost of the on-demand usage (beyond the free units), in USD cents.
• ↳ estimatedTotalCost number required
  EstimatedTotalCost is the estimated total cost of billing family’s usage for the current billing cycle, in USD cents.