> ## Documentation Index > Fetch the complete documentation index at: https://docs.useweve.com/llms.txt > Use this file to discover all available pages before exploring further. # Plano e uso do club > O que o club assina, o ciclo corrente e o uso de cada recurso. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/billing 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.useweve.com 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 - name: gamification - name: support - name: help paths: /v1/clubs/{clubId}/billing: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - clubs summary: O plano e o uso do club description: | O que o club assina, o ciclo de uso corrente e, por recurso, o que ele tem e o quanto usou. É leitura: o que o club TEM é decidido por quem cobra, fora deste contrato. Com `managed` falso o club ainda não tem plano — tudo é medido e nada é recusado, e `plan` vem nulo. O ciclo de uso é MENSAL mesmo no plano anual: a franquia é por mês. operationId: getClubBilling responses: '200': description: O plano e o uso content: application/json: schema: $ref: '#/components/schemas/ClubBilling' '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: ClubBilling: type: object required: - managed - portal_available - period_start - period_end - plan - interval - next_invoice_at - pending_plan - past_due - plan_options - addons - available_addons - resources properties: managed: type: boolean description: Se o club está sob limites. Falso é o club que ainda não tem plano. portal_available: type: boolean description: | Se a cobrança tem como responder — o ambiente tem a Stripe configurada. É o que decide se a tela oferece trocar de plano, contratar adicional e abrir o portal: um botão que só responderia 501 não é botão. period_start: type: string format: date-time period_end: type: string format: date-time plan: nullable: true allOf: - $ref: '#/components/schemas/BillingProduct' interval: allOf: - $ref: '#/components/schemas/BillingInterval' description: O intervalo do plano de agora. next_invoice_at: type: string format: date-time nullable: true description: > A próxima fatura — a virada do ciclo pago do plano na Stripe. Nulo no club sem assinatura (ainda não pagou nada). É a data que a tela diz ao cobrar, e o dia em que uma descida marcada passa a valer. pending_plan: nullable: true allOf: - $ref: '#/components/schemas/BillingPendingPlan' description: A descida marcada para a virada, se há uma. past_due: nullable: true allOf: - $ref: '#/components/schemas/BillingPastDue' description: A renovação sem pagar, se há uma. plan_options: type: array description: Os planos à venda, com os preços que valem para este club. items: $ref: '#/components/schemas/BillingPlanOption' addons: type: array items: $ref: '#/components/schemas/BillingProduct' available_addons: type: array description: > Os adicionais do catálogo, para a tela oferecer. Vazio onde não há o que oferecer: club sem plano, ou ambiente sem a Stripe. items: $ref: '#/components/schemas/BillingAddonOffer' resources: type: array items: $ref: '#/components/schemas/BillingResource' BillingProduct: type: object required: - key - name properties: key: type: string example: plan_linen name: type: string example: Linho BillingInterval: type: string enum: - month - year BillingPendingPlan: type: object required: - plan - interval - effective_at properties: plan: $ref: '#/components/schemas/BillingProduct' interval: $ref: '#/components/schemas/BillingInterval' effective_at: type: string format: date-time description: A virada do ciclo pago, quando a descida passa a valer. BillingPastDue: type: object required: - since - downgrade_at properties: since: type: string format: date-time description: Desde quando a renovação está sem pagar. downgrade_at: type: string format: date-time description: | Quando o club volta ao Grátis se nada mudar. Cadastrar um cartão que passe no portal resolve sozinho: a Stripe refaz a cobrança. BillingPlanOption: type: object required: - key - name - monthly_price_cents - yearly_price_cents - includes properties: key: type: string example: plan_cotton name: type: string example: Algodão monthly_price_cents: type: integer format: int64 description: A mensalidade — a combinada com o club, quando há uma. yearly_price_cents: type: integer format: int64 description: O ano fechado. Zero é plano sem anual (o Grátis). includes: type: array description: Os limites do plano — o que ele comporta, recurso a recurso. items: $ref: '#/components/schemas/BillingAllowance' BillingAddonOffer: type: object required: - key - name - monthly_price_cents - setup_price_cents - contracted - removable - ends_at - trial_days - trial_ends_at - unavailable_reason - required_plans - includes properties: key: type: string example: addon_lives name: type: string example: Lives monthly_price_cents: type: integer format: int64 description: >- A mensalidade, em centavos de real — a combinada com o club, quando há uma. setup_price_cents: type: integer format: int64 description: > A implantação, cobrada UMA vez, na mesma fatura da primeira mensalidade (o app próprio). Zero é adicional sem implantação. contracted: type: boolean ends_at: type: string format: date-time nullable: true description: > O adicional foi removido e sai nesta data — a virada do que já foi pago; até lá segue funcionando. Contratá-lo de novo antes disso o mantém, sem cobrança. Nulo no adicional que não está saindo. trial_days: type: integer description: > Os dias de teste grátis que contratar AGORA dá: o adicional entra sem cobrança e, no fim do teste, a mensalidade passa a ser cobrada no cartão cadastrado (o proporcional até a renovação do plano). Zero é contratar pagando: o adicional não tem teste (o app próprio), ou o club já o testou — é um teste por adicional. example: 3 trial_ends_at: type: string format: date-time nullable: true description: > O adicional está em teste até esta data, quando a cobrança começa. Removê-lo antes encerra o teste na hora, sem cobrança. Nulo fora do teste. removable: type: boolean description: > Se o club pode removê-lo sozinho. Falso no adicional que ele não tem, e no que foi concedido pela nossa equipe em vez de contratado. unavailable_reason: nullable: true allOf: - $ref: '#/components/schemas/BillingAddonUnavailable' required_plans: type: array description: >- Os nomes dos planos que vendem o adicional. Vazio é "qualquer plano". items: type: string example: Linho includes: type: array description: | O que o adicional traz por mês, recurso a recurso, e o que acontece depois — é o que a tela diz ANTES de contratar. items: $ref: '#/components/schemas/BillingAllowance' BillingResource: type: object required: - key - name - kind - granted - unlimited - allowance - balance - used - overage - bills properties: key: type: string example: campaign_sends name: type: string example: Envios de campanha kind: $ref: '#/components/schemas/BillingResourceKind' granted: type: boolean description: > Se o club tem o recurso. Num `flag`, é a resposta inteira. Nos outros, separa "acabou a franquia" de "não contratou". unlimited: type: boolean allowance: type: integer format: int64 description: > A franquia do ciclo (ou, num `gauge`, o teto). Bytes em espaço e consumo de vídeo, pessoas-minuto em live, unidade simples no resto. Não vale com `unlimited`. balance: type: integer format: int64 description: >- O que resta de saldo avulso — pacote comprado ou cortesia. Gasta-se depois da franquia. used: type: integer format: int64 description: O total do ciclo num `metered`; o tamanho de agora num `gauge`. overage: type: integer format: int64 description: O que passou da franquia e dos saldos, e é cobrado à parte. bills: type: boolean description: | O que acontece quando o que há acaba: verdadeiro cobra o excedente, falso recusa o uso. 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 BillingAllowance: type: object required: - key - name - unlimited - allowance - overage - overage_price_cents - overage_unit description: | O que um produto do catálogo dá de um recurso: a franquia do ciclo (ou, num estoque, o teto) e o que acontece quando ela acaba. properties: key: type: string description: A chave do recurso, a mesma de `BillingResource.key`. example: ai_messages name: type: string example: Mensagens de IA unlimited: type: boolean allowance: type: integer format: int64 description: >- A franquia, nas unidades de `BillingResource.allowance`. Não vale com `unlimited`. overage: $ref: '#/components/schemas/BillingOverage' overage_price_cents: type: integer format: int64 description: O preço do extra a cada `overage_unit`. Zero com `overage` `block`. overage_unit: type: integer format: int64 description: >- A quantos do recurso o `overage_price_cents` se refere (mil mensagens, 100 GB). BillingAddonUnavailable: type: string enum: - not_in_plan - not_self_service description: > Por que o club não pode contratar o adicional pela tela. `not_in_plan`: o plano dele não o vende (`required_plans` diz quais vendem). `not_self_service`: contrata-se com a nossa equipe. BillingResourceKind: type: string enum: - flag - gauge - metered description: > Como o recurso se mede. `flag` é ter ou não ter; `gauge` é estoque — o tamanho de agora, como o número de alunos; `metered` é fluxo — o total do ciclo, que zera quando ele vira. BillingOverage: type: string enum: - bill - block description: | Depois da franquia: `bill` cobra o extra na fatura seguinte e nada para; `block` recusa o uso — é o limite do plano. 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. ````