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

# Gerar link de checkout (Stripe)

> Cria uma página de checkout hospedada do Stripe e retorna a url para o usuário abrir no navegador — nada é cobrado até ele concluir lá. purpose:"wallet_topup" (exige amount > 0, na moeda da conta) gera um pagamento único que credita a carteira pré-paga; purpose:"add_card" gera uma página para salvar um cartão. Ação de conta: requer key escopada a TENANT (403 NUMBER_SCOPE_NOT_ALLOWED para key de número). Só Stripe.

**Requer uma chave com escopo de tenant.**



## OpenAPI

````yaml openapi.pt.json POST /v1/billing/checkout
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/billing/checkout:
    post:
      tags:
        - Billing
      summary: Gerar link de checkout (Stripe)
      description: >-
        Cria uma página de checkout hospedada do Stripe e retorna a url para o
        usuário abrir no navegador — nada é cobrado até ele concluir lá.
        purpose:"wallet_topup" (exige amount > 0, na moeda da conta) gera um
        pagamento único que credita a carteira pré-paga; purpose:"add_card" gera
        uma página para salvar um cartão. Ação de conta: requer key escopada a
        TENANT (403 NUMBER_SCOPE_NOT_ALLOWED para key de número). Só Stripe.


        **Requer uma chave com escopo de tenant.**
      operationId: post_billing_checkout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                purpose:
                  type: string
                  description: Finalidade da página de checkout.
                  example: wallet_topup
                amount:
                  type: string
                  description: >-
                    Valor a creditar na carteira, na moeda da conta (obrigatório
                    para wallet_topup).
                  example: '50'
                successUrl:
                  type: string
                  description: URL de redirecionamento após o sucesso.
                  example: https://app.acme.com/billing/ok
                cancelUrl:
                  type: string
                  description: URL de redirecionamento se cancelar.
                  example: https://app.acme.com/billing
              required:
                - purpose
            example:
              purpose: wallet_topup
              amount: 50
      responses:
        '200':
          description: Recarregar carteira
          content:
            application/json:
              example:
                url: https://checkout.stripe.com/c/pay/cs_test_...
                purpose: wallet_topup
                orderId: cto_01HZX...
                amount: 50
                currency: BRL
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de número usada em endpoint exclusivo de tenant
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Number-scoped keys cannot call tenant endpoints
                code: NUMBER_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````