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

# Read current workspace provider benefits

> Returns retained plan terms and paid provider benefit availability. Execution rechecks admission.

Authentication: workspace API key in `Authorization: Bearer <key>`.

## Errors

| Status | Meaning |
| - | - |
| 401 | The request conflicts with current state or a retained request identity. |
| 503 | A required service is unavailable. Respect Retry-After when present. |


## OpenAPI

````yaml openapi.json GET /api/v2/billing/entitlements
openapi: 3.1.1
info:
  title: Deepline API
  version: v2
  description: >-
    Discover typed GTM tools and callable Plays, then execute a tool or start
    and inspect a durable Deepline Play run. Use the MCP endpoint when your
    client supports Model Context Protocol.
  contact:
    name: Deepline support
    email: team@deepline.com
    url: https://deepline.com/contact
servers:
  - url: https://code.deepline.com
    description: Deepline production runtime API
security: []
tags:
  - name: Health
    description: Availability checks.
  - name: Billing
    description: Safe recovery of existing purchase intent.
  - name: Tools
    description: Discover and execute typed provider tools.
  - name: Plays
    description: Discover, start, and inspect durable Play runs.
externalDocs:
  description: API reference
  url: https://deepline.com/docs/api-reference
paths:
  /api/v2/billing/entitlements:
    get:
      tags:
        - Billing
      summary: Read current workspace provider benefits
      description: >-
        Returns retained plan terms and paid provider benefit availability.
        Execution rechecks admission.
      operationId: getBillingEntitlements
      responses:
        '200':
          description: A successful Runtime API response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  org_id:
                    type: string
                  as_of:
                    type: number
                  plan:
                    type:
                      - object
                      - 'null'
                    properties:
                      sku:
                        type: string
                      name:
                        type: string
                      catalog_revision:
                        type:
                          - string
                          - 'null'
                      included_credits:
                        type: number
                      interval:
                        type:
                          - string
                          - 'null'
                  benefits:
                    type: object
                    properties:
                      quickenrichUnlimited:
                        type: object
                        properties:
                          status:
                            type: string
                          value:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              requestsPerMinute:
                                type: number
                            required:
                              - enabled
                              - requestsPerMinute
                          expiresAt:
                            type: number
                        required:
                          - status
                          - value
                      peopleSearch:
                        type: object
                        properties:
                          status:
                            type: string
                          value:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              requestsPerMinute:
                                type: number
                              profilesPerMonth:
                                type: number
                              overageCreditsPerProfile:
                                type: number
                            required:
                              - enabled
                              - requestsPerMinute
                              - profilesPerMonth
                          expiresAt:
                            type: number
                          usage:
                            type: object
                            properties:
                              month:
                                type: string
                              periodStartsAt:
                                type: number
                              resetsAt:
                                type: number
                              resetsOn:
                                type: string
                              limit:
                                type: number
                              consumed:
                                type: number
                              remaining:
                                type: number
                            required:
                              - month
                              - limit
                              - consumed
                              - remaining
                        required:
                          - status
                          - value
                          - usage
                      includedStorage:
                        type: object
                        properties:
                          status:
                            type: string
                          usage:
                            type: object
                            properties:
                              limit:
                                type: number
                              consumed:
                                type: number
                              remaining:
                                type: number
                              measuredDay:
                                type: string
                              overageCharged:
                                type: boolean
                            required:
                              - limit
                              - consumed
                              - remaining
                              - measuredDay
                              - overageCharged
                        required:
                          - status
                          - usage
                    required: []
                  effective_limits:
                    type: object
                    properties:
                      quickenrichUnlimited:
                        type: object
                        properties:
                          baseline:
                            type: number
                          effective:
                            type: number
                          source:
                            enum:
                              - plan
                              - override
                          override_expires_at:
                            type: number
                        required:
                          - baseline
                          - effective
                          - source
                    required: []
                required:
                  - org_id
                  - as_of
                  - plan
                  - benefits
                  - effective_limits
        '401':
          description: >-
            The request conflicts with current state or a retained request
            identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Unauthorized
        '503':
          description: A required service is unavailable. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Unauthorized
          headers:
            Retry-After:
              description: Minimum whole seconds to wait before retrying the request.
              schema:
                type: integer
                minimum: 1
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          oneOf:
            - type: string
              description: Route-specific error message.
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
                resolution:
                  type: string
              additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Deepline workspace API key
      description: >-
        Create a workspace API key in the Deepline dashboard before calling
        authenticated endpoints.

````

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