Sign in
Usage

Report usage measurements

Reports usage measurements for metered features. The reported usage is used to track, limit, and bill customer consumption.

post/api/v1/usage

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

Response

The recorded usage measurement objects.

Changes

Changed in 11 of the 115 revisions of this API.107

  • b876edd1a4fc51See the full diff
    • ●

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the InvoicePreviewNotAvailableForDraftContract enum value from the response property for the response status

      response-property-enum-value-removed

  • 8b3d4ace525d1See the full diff
    • ○

      added the required property /// to the response with the status

      response-required-property-added

  • 58bb216ff8ce1See the full diff
    • ●

      added the new GovernanceNotEnabled enum value to the response property for the response status

      response-property-enum-value-added

  • a8a3b5df46c41See the full diff
    • ○

      added the new optional request property //

      new-optional-request-property

  • d7ea774f954e1See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 6f80b1b6dd031See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 7296f9e4b6541See the full diff
    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

      response-property-enum-value-added

  • 3acd63d6c8612See the full diff
    • ○

      added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • ○

      added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the response property for the response status

      response-property-enum-value-added