Usage and spend

Period cost estimate: subscription fee, usage charges and projected allowance use

get/v1/organizations/{organization_id}/usage/estimate

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/organizations/{organization_id}/usage/estimate
  • Auth: HTTP bearer

Path parameters

organization_idstring uuid required

UUIDv7, lowercase canonical form.

Response

Default Response

organization_idstring uuid required

UUIDv7, lowercase canonical form.

currencystring nullable required
usage_charges_minorinteger required

Overage charged this period so far, whole minor units (floor; spend_cap.charges_minor). 0 while overage is off or unavailable and nothing was charged this period.

estimated_total_minorinteger nullable required

subscription_fee.amount_minor + usage_charges_minor; null without a subscription price.

overagestring nullable required

The plan's overage policy: disabled | opt_in | enabled.

notesstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.