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

# Read account subscription and usage

> Requires a verified Firebase or signed personal MCP user with current unblocked team membership. Team API keys and OAuth tokens cannot act as their creator. Writes and operation readback/recovery require a current billing-account administrator. Effects are shared by the billing account. Staging always uses sandbox billing; credential livemode does not choose billing environment. Subscriptions are bounded to 100 with subscriptions_has_more. Null usage means unavailable, not zero.



## OpenAPI

````yaml openapi.json GET /teams/{id}/billing/summary
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/billing/summary:
    get:
      tags:
        - Account Billing
      summary: Read account subscription and usage
      description: >-
        Requires a verified Firebase or signed personal MCP user with current
        unblocked team membership. Team API keys and OAuth tokens cannot act as
        their creator. Writes and operation readback/recovery require a current
        billing-account administrator. Effects are shared by the billing
        account. Staging always uses sandbox billing; credential livemode does
        not choose billing environment. Subscriptions are bounded to 100 with
        subscriptions_has_more. Null usage means unavailable, not zero.
      operationId: accountBillingSummary
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Inspect the returned state before reporting completion.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - success
                  - data
                  - timestamp
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/AccountBillingSummary'
                  timestamp:
                    type: number
        '400':
          description: Invalid body, cursor or fiscal fields.
        '401':
          description: Verified Firebase or personal MCP identity required.
        '403':
          description: Current membership or billing administrator authority required.
        '404':
          description: Team, plan, or operation not found in scope.
        '409':
          description: >-
            Account lock, changed operation parameters, ambiguous customer or
            incompatible plan state. Read current state before deciding the next
            action.
        '502':
          description: >-
            Billing result unconfirmed or upstream unavailable. Read the
            original operation ID before retrying.
        '503':
          description: >-
            Runtime project, application origin or internal service
            authorization is not configured.
      security:
        - bearerAuth: []
components:
  schemas:
    AccountBillingSummary:
      type: object
      additionalProperties: false
      required:
        - team_id
        - billing_account_id
        - effect_scope
        - provider_environment
        - can_manage
        - customer_id
        - plan
        - usage
        - subscriptions
        - subscriptions_has_more
      properties:
        team_id:
          type: string
        billing_account_id:
          type: string
        effect_scope:
          type: string
          enum:
            - billing_account_shared
        provider_environment:
          type: string
          enum:
            - sandbox
            - production
        can_manage:
          type: boolean
        customer_id:
          type: string
          nullable: true
        plan:
          type: object
          additionalProperties: false
          required:
            - id
            - name
            - pricing_version
            - subscription_id
            - status
            - billing_cycle
            - features
          properties:
            id:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            pricing_version:
              type: string
              nullable: true
            subscription_id:
              type: string
              nullable: true
            status:
              type: string
              nullable: true
            billing_cycle:
              type: string
              nullable: true
            features:
              type: object
              additionalProperties: false
              properties:
                includedDocuments:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                seats:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                maxClients:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                selfBillingPortal:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                maxIntegrations:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                customerPortal:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                technicalSupport:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                apiAndWebhooks:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                customDomain:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                multipleIssuerAccounts:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                analyticsAndReports:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                dedicatedSupportChannel:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                supplierMode:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                erps:
                  oneOf:
                    - type: string
                    - type: number
                    - type: boolean
        usage:
          type: object
          additionalProperties: false
          required:
            - used_documents
            - included_documents
            - credits
            - current_period_start
            - current_period_end
          properties:
            used_documents:
              type: number
              nullable: true
            included_documents:
              type: number
              nullable: true
            credits:
              type: number
              nullable: true
            current_period_start:
              type: number
              nullable: true
            current_period_end:
              type: number
              nullable: true
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/AccountBillingSubscription'
        subscriptions_has_more:
          type: boolean
    AccountBillingSubscription:
      type: object
      additionalProperties: false
      required:
        - id
        - status
        - plan_id
        - billing_cycle
        - currency
        - current_period_start
        - current_period_end
        - cancel_at
        - trial_end
        - cancel_at_period_end
      properties:
        id:
          type: string
        status:
          type: string
        plan_id:
          type: string
          nullable: true
        billing_cycle:
          type: string
          nullable: true
        currency:
          type: string
          nullable: true
        current_period_start:
          type: number
          nullable: true
        current_period_end:
          type: number
          nullable: true
        cancel_at:
          type: number
          nullable: true
        trial_end:
          type: number
          nullable: true
        cancel_at_period_end:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

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