> ## Documentation Index
> Fetch the complete documentation index at: https://commet.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get feature access

> Get one feature's access and current usage for a customer. To evaluate a prospective consumption, use POST /usage/check.

> [!NOTE]
>
> This reference describes API version `2026-07-31`. Send `Commet-Version: 2026-07-31` with your request.


## OpenAPI

````yaml /openapi/en/rest/2026-07-31.json get /feature-access/{code}
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-07-31'
  description: Billing and payments API for SaaS and AI products.
servers:
  - url: https://commet.co/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Test Clock
    description: >-
      Simulate the passage of time in sandbox to test billing flows. Mirrors
      Stripe test clocks: forward-only and sandbox-only.
  - name: Customers
  - name: Subscriptions
  - name: Plans
  - name: Markets
    description: >-
      Reusable country groups for market-specific prices and selectable price
      variants.
  - name: Offers
  - name: Promo Codes
  - name: Features
  - name: Usage
  - name: Seats
  - name: Quota
  - name: Add-ons
  - name: Portal
  - name: Credit Packs
  - name: Plan Groups
  - name: Invoices
  - name: Payments
    description: >-
      One-time payments with no subscription or plan. Charge a customer's saved
      payment method off-session, or create a payment link the customer opens to
      pay. Tax, invoice, and receipt are handled automatically.
  - name: Transactions
  - name: Webhooks
  - name: API Keys
  - name: Payouts
    description: >-
      Withdraw available balance to your bank and manage the payout account
      (verification + destination bank accounts).
  - name: Provisioning
    description: >-
      Take ownership of an organization an agent provisioned headlessly. The
      agent holds the API keys from the start; a human claims the account
      through a claim link.
paths:
  /feature-access/{code}:
    get:
      tags:
        - Features
      summary: Get feature access
      description: >-
        Get one feature's access and current usage for a customer. To evaluate a
        prospective consumption, use POST /usage/check.
      operationId: get-feature-access
      parameters:
        - name: code
          in: path
          required: true
          schema:
            type: string
        - name: customerId
          in: query
          required: true
          schema:
            type: string
        - name: Commet-Version
          in: header
          required: false
          description: >-
            API version used by this reference. Send this header to select this
            contract explicitly.
          schema:
            type: string
            default: '2026-07-31'
          example: '2026-07-31'
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureAccess'
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
            RateLimit-Reset:
              description: Seconds until the rate limit window resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  headers:
    RequestId:
      description: >-
        Server-generated identifier that correlates this response with Platform
        logs.
      schema:
        type: string
        format: uuid
  schemas:
    FeatureAccess:
      oneOf:
        - type: object
          properties:
            code:
              type: string
              description: Unique feature code.
            name:
              type: string
              description: Display name of the feature.
            unitName:
              description: Display name for one product unit, or null when not applicable.
              type:
                - string
                - 'null'
            allowed:
              type: boolean
              description: >-
                Whether the customer can currently access or consume the
                feature.
            type:
              type: string
              const: boolean
            enabled:
              type: boolean
              description: Whether the feature is enabled.
            baseAccess:
              anyOf:
                - type: object
                  properties:
                    enabled:
                      type: boolean
                  required:
                    - enabled
                  additionalProperties: false
                - type: 'null'
            object:
              type: string
              const: feature_access
            livemode:
              type: boolean
          required:
            - code
            - name
            - unitName
            - allowed
            - type
            - enabled
            - object
            - livemode
          additionalProperties: false
        - type: object
          properties:
            code:
              type: string
              description: Unique feature code.
            name:
              type: string
              description: Display name of the feature.
            unitName:
              description: Display name for one product unit, or null when not applicable.
              type:
                - string
                - 'null'
            allowed:
              type: boolean
              description: >-
                Whether the customer can currently access or consume the
                feature.
            type:
              type: string
              const: usage
            consumption:
              oneOf:
                - type: object
                  properties:
                    model:
                      type: string
                      const: metered
                      description: >-
                        Usage is measured against an included allowance and
                        overage.
                    period:
                      type: object
                      properties:
                        start:
                          type: string
                          format: date-time
                          description: Inclusive usage period start.
                        end:
                          type: string
                          format: date-time
                          description: Exclusive usage period end.
                      required:
                        - start
                        - end
                      additionalProperties: false
                      description: Time range used to calculate this feature's consumption.
                    unitsUsed:
                      type: number
                      description: Product units recorded during the period.
                    includedUnits:
                      type: number
                      description: >-
                        Product units included in the subscription for the
                        period.
                    remainingUnits:
                      type: number
                      description: >-
                        Included units not yet consumed. Absent when usage is
                        unlimited.
                    unlimited:
                      type: boolean
                      description: Whether the feature has no usage limit.
                    overage:
                      type: object
                      properties:
                        enabled:
                          type: boolean
                          description: >-
                            Whether usage above the included amount is allowed
                            and billed.
                        units:
                          type: number
                          description: Units consumed above the included amount.
                        unitPrice:
                          type: object
                          properties:
                            amount:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                              description: >-
                                Integer rate amount. Divide by scale to obtain
                                the price.
                            currency:
                              type: string
                              description: Lowercase ISO 4217 currency code.
                            scale:
                              type: number
                              const: 10000
                              description: >-
                                Divide amount by scale to obtain the major-unit
                                price.
                          required:
                            - amount
                            - currency
                            - scale
                          additionalProperties: false
                          description: Price for one additional product unit.
                      required:
                        - enabled
                        - units
                      additionalProperties: false
                  required:
                    - model
                    - period
                    - unitsUsed
                    - includedUnits
                    - unlimited
                    - overage
                  additionalProperties: false
                - type: object
                  properties:
                    model:
                      type: string
                      const: credits
                      description: Product usage consumes credits from a shared pool.
                    period:
                      type: object
                      properties:
                        start:
                          type: string
                          format: date-time
                          description: Inclusive usage period start.
                        end:
                          type: string
                          format: date-time
                          description: Exclusive usage period end.
                      required:
                        - start
                        - end
                      additionalProperties: false
                      description: Time range used to calculate this feature's consumption.
                    unitsUsed:
                      type: number
                      description: Product units recorded during the period.
                    creditsPerUnit:
                      type: integer
                      exclusiveMinimum: 0
                      maximum: 9007199254740991
                      description: Credits deducted for each product unit.
                    creditsConsumed:
                      type: number
                      minimum: 0
                      description: >-
                        Actual credits deducted by this feature during the
                        period.
                    availableUnits:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        Additional product units available from the current
                        shared credit pool at this feature's conversion rate.
                  required:
                    - model
                    - period
                    - unitsUsed
                    - creditsPerUnit
                    - creditsConsumed
                    - availableUnits
                  additionalProperties: false
                - type: object
                  properties:
                    model:
                      type: string
                      const: balance
                      description: Product usage deducts money from a shared balance.
                    period:
                      type: object
                      properties:
                        start:
                          type: string
                          format: date-time
                          description: Inclusive usage period start.
                        end:
                          type: string
                          format: date-time
                          description: Exclusive usage period end.
                      required:
                        - start
                        - end
                      additionalProperties: false
                      description: Time range used to calculate this feature's consumption.
                    unitsUsed:
                      type: number
                      description: Product units recorded during the period.
                    spent:
                      type: object
                      properties:
                        amount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                          description: Amount in the currency's smallest unit.
                        currency:
                          type: string
                          description: Lowercase ISO 4217 currency code.
                      required:
                        - amount
                        - currency
                      additionalProperties: false
                      description: >-
                        Actual money deducted for this feature during the
                        period.
                    availableUnits:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                      description: >-
                        Estimated additional units available from the current
                        shared balance at this feature's fixed price. Absent for
                        dynamic pricing.
                    unitPrice:
                      type: object
                      properties:
                        amount:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: >-
                            Integer rate amount. Divide by scale to obtain the
                            price.
                        currency:
                          type: string
                          description: Lowercase ISO 4217 currency code.
                        scale:
                          type: number
                          const: 10000
                          description: >-
                            Divide amount by scale to obtain the major-unit
                            price.
                      required:
                        - amount
                        - currency
                        - scale
                      additionalProperties: false
                      description: Price for one additional product unit.
                  required:
                    - model
                    - period
                    - unitsUsed
                    - spent
                  additionalProperties: false
            baseAccess:
              anyOf:
                - type: object
                  properties:
                    includedUnits:
                      type: number
                    unlimited:
                      type: boolean
                  required:
                    - includedUnits
                    - unlimited
                  additionalProperties: false
                - type: 'null'
            object:
              type: string
              const: feature_access
            livemode:
              type: boolean
          required:
            - code
            - name
            - unitName
            - allowed
            - type
            - consumption
            - object
            - livemode
          additionalProperties: false
        - type: object
          properties:
            code:
              type: string
              description: Unique feature code.
            name:
              type: string
              description: Display name of the feature.
            unitName:
              description: Display name for one product unit, or null when not applicable.
              type:
                - string
                - 'null'
            allowed:
              type: boolean
              description: >-
                Whether the customer can currently access or consume the
                feature.
            type:
              type: string
              const: seats
            usage:
              type: object
              properties:
                period:
                  type: object
                  properties:
                    start:
                      type: string
                      format: date-time
                      description: Inclusive usage period start.
                    end:
                      type: string
                      format: date-time
                      description: Exclusive usage period end.
                  required:
                    - start
                    - end
                  additionalProperties: false
                  description: Time range used to calculate this feature's consumption.
                unitsUsed:
                  type: number
                  description: Current units assigned or in use.
                includedUnits:
                  type: number
                  description: Units included in the subscription for the period.
                remainingUnits:
                  type: number
                  description: >-
                    Included units still available. Absent when usage is
                    unlimited.
                unlimited:
                  type: boolean
                  description: Whether the feature has no usage limit.
                overage:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      description: >-
                        Whether usage above the included amount is allowed and
                        billed.
                    units:
                      type: number
                      description: Units consumed above the included amount.
                    unitPrice:
                      type: object
                      properties:
                        amount:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: >-
                            Integer rate amount. Divide by scale to obtain the
                            price.
                        currency:
                          type: string
                          description: Lowercase ISO 4217 currency code.
                        scale:
                          type: number
                          const: 10000
                          description: >-
                            Divide amount by scale to obtain the major-unit
                            price.
                      required:
                        - amount
                        - currency
                        - scale
                      additionalProperties: false
                      description: Price for one additional product unit.
                  required:
                    - enabled
                    - units
                  additionalProperties: false
              required:
                - period
                - unitsUsed
                - includedUnits
                - unlimited
                - overage
              additionalProperties: false
            baseAccess:
              anyOf:
                - type: object
                  properties:
                    includedUnits:
                      type: number
                    unlimited:
                      type: boolean
                  required:
                    - includedUnits
                    - unlimited
                  additionalProperties: false
                - type: 'null'
            object:
              type: string
              const: feature_access
            livemode:
              type: boolean
          required:
            - code
            - name
            - unitName
            - allowed
            - type
            - usage
            - object
            - livemode
          additionalProperties: false
        - type: object
          properties:
            code:
              type: string
              description: Unique feature code.
            name:
              type: string
              description: Display name of the feature.
            unitName:
              description: Display name for one product unit, or null when not applicable.
              type:
                - string
                - 'null'
            allowed:
              type: boolean
              description: >-
                Whether the customer can currently access or consume the
                feature.
            type:
              type: string
              const: quota
            usage:
              type: object
              properties:
                period:
                  type: object
                  properties:
                    start:
                      type: string
                      format: date-time
                      description: Inclusive usage period start.
                    end:
                      type: string
                      format: date-time
                      description: Exclusive usage period end.
                  required:
                    - start
                    - end
                  additionalProperties: false
                  description: Time range used to calculate this feature's consumption.
                unitsUsed:
                  type: number
                  description: Current units assigned or in use.
                includedUnits:
                  type: number
                  description: Units included in the subscription for the period.
                remainingUnits:
                  type: number
                  description: >-
                    Included units still available. Absent when usage is
                    unlimited.
                unlimited:
                  type: boolean
                  description: Whether the feature has no usage limit.
                overage:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      description: >-
                        Whether usage above the included amount is allowed and
                        billed.
                    units:
                      type: number
                      description: Units consumed above the included amount.
                    unitPrice:
                      type: object
                      properties:
                        amount:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: >-
                            Integer rate amount. Divide by scale to obtain the
                            price.
                        currency:
                          type: string
                          description: Lowercase ISO 4217 currency code.
                        scale:
                          type: number
                          const: 10000
                          description: >-
                            Divide amount by scale to obtain the major-unit
                            price.
                      required:
                        - amount
                        - currency
                        - scale
                      additionalProperties: false
                      description: Price for one additional product unit.
                  required:
                    - enabled
                    - units
                  additionalProperties: false
                billedUnits:
                  type: number
                  description: >-
                    Highest quota reached during the period and used for
                    billing.
              required:
                - period
                - unitsUsed
                - includedUnits
                - unlimited
                - overage
                - billedUnits
              additionalProperties: false
            baseAccess:
              anyOf:
                - type: object
                  properties:
                    includedUnits:
                      type: number
                    unlimited:
                      type: boolean
                  required:
                    - includedUnits
                    - unlimited
                  additionalProperties: false
                - type: 'null'
            object:
              type: string
              const: feature_access
            livemode:
              type: boolean
          required:
            - code
            - name
            - unitName
            - allowed
            - type
            - usage
            - object
            - livemode
          additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type: string
            details: {}
            doc_url:
              type: string
          required:
            - type
            - code
            - message
            - doc_url
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.