> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # O que o club pode usar > Por recurso, se o club pode usá-lo agora: disponível, fora do plano ou no limite. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/entitlements openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email - name: exports - name: certificates - name: terms - name: mcp paths: /v1/clubs/{clubId}/entitlements: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - clubs summary: O que o club pode usar agora description: > Por recurso, se o club pode usá-lo agora — a pergunta que as telas fazem ANTES de oferecer uma ação que responderia 402. É a mesma conta da recusa: `not_in_plan` é o `feature_not_in_plan` e `limit_reached` é o `limit_reached` que a escrita devolveria. Qualquer pessoa da equipe lê, e é por isso que é outra rota: o plano e o uso (`GET /v1/clubs/{clubId}/billing`) são de quem administra, e aqui não há preço, franquia nem consumo — só o que a tela precisa para não prometer o que o plano não entrega. O 402 da escrita continua sendo a garantia; esta leitura só o antecipa. Club sem plano (fora dos limites) tem tudo `available`. operationId: getClubEntitlements responses: '200': description: O que o club pode usar content: application/json: schema: $ref: '#/components/schemas/ClubEntitlements' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid schemas: ClubEntitlements: type: object required: - resources properties: resources: type: array description: Um por recurso do catálogo, na ordem da tela de plano. items: $ref: '#/components/schemas/ClubEntitlement' ClubEntitlement: type: object required: - key - state - addon properties: key: type: string description: A chave do recurso, a mesma de `BillingResource.key`. example: ai_messages state: $ref: '#/components/schemas/EntitlementState' addon: type: boolean description: > Se o recurso se contrata à parte (adicional). Falso é o que vem num plano maior — é o que separa "contrate o adicional" de "suba de plano". ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string EntitlementState: type: string enum: - available - not_in_plan - limit_reached description: > `available` é poder usar — inclusive quando o excedente é cobrado. `not_in_plan` é o club não ter o recurso. `limit_reached` é um recurso que BLOQUEIA (não cobra o excedente) já não comportar nem mais um. responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Conectar agentes (MCP)](/essentials/mcp.md) - [Mentorias](/essentials/mentorships.md) - [Disponibilidade de endereço](/api-reference/clubs/slug-availability.md) - [Club do endereço inteiro](/api-reference/clubs/by-host.md) - [Club de um endereço](/api-reference/clubs/by-slug.md)