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

# Criar Assinatura

> Cria uma nova assinatura recorrente para um cliente. Suporta os métodos de pagamento: **CreditCard** e **PIX**. O campo `subscription.interval` define o ciclo em dias (ex: 30 para mensal). Requer o header `account` com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting.


<Note>
  Requer o header `account`. Passa por validações de fraude e bloqueio de clientes.
</Note>


## OpenAPI

````yaml POST /v1/subscriptions
openapi: 3.1.0
info:
  title: 4Selet Pay API
  description: >
    API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
    cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
    rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
  version: 1.0.0
  contact:
    name: 4Selet Pay
    email: suporte@4selet.com.br
servers:
  - url: https://sandbox.4seletpay.com.br/api
    description: Servidor de Sandbox
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Rotas de autenticação e criação de usuários
  - name: Cobranças
    description: Criação, consulta, cancelamento e reembolso de cobranças
  - name: Pedidos
    description: Consulta de pedidos e gerenciamento de confirmações desafiadas
  - name: Assinaturas
    description: Criação e gerenciamento de assinaturas recorrentes
  - name: Faturas
    description: Gerenciamento de faturas e pagamento de faturas em atraso
  - name: Clientes Bloqueados
    description: Gerenciamento de lista negra de clientes
  - name: Contas
    description: Criação e gerenciamento de contas na plataforma
  - name: Aplicativo
    description: Endpoints para dashboard e uso via aplicativo mobile
  - name: Notificações Push
    description: Envio e gerenciamento de notificações push
  - name: Utilitários
    description: Endpoints utilitários como listagem de fusos horários
  - name: Gestão
    description: Relatórios gerenciais (acesso restrito a Super Admins)
  - name: Webhooks
    description: Endpoints para receber notificações de gateways de pagamento
  - name: Endpoints de Webhook
    description: >-
      Gerenciamento de endpoints de webhook para receber notificações de eventos
      da plataforma
  - name: Links de Pagamento
    description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
paths:
  /v1/subscriptions:
    post:
      tags:
        - Assinaturas
      summary: Criar assinatura
      description: >
        Cria uma nova assinatura recorrente para um cliente. Suporta os métodos
        de pagamento: **CreditCard** e **PIX**. O campo `subscription.interval`
        define o ciclo em dias (ex: 30 para mensal). Requer o header `account`
        com o código da conta. Passa por validações de fraude, bloqueio de
        clientes e rate limiting.
      operationId: createSubscription
      parameters:
        - $ref: '#/components/parameters/AccountHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreSubscriptionRequest'
            example:
              international: false
              client:
                client_ip: 192.168.1.100
                name: Carlos Ferreira
                email: carlos@exemplo.com.br
                gender: Male
                birthdate: '1985-06-20'
                phone:
                  ddi: 55
                  ddd: 11
                  number: '977776666'
                document:
                  type: CPF
                  number: 111.222.333-44
                address:
                  zipcode: 04538-132
                  street: Rua Fidêncio Ramos
                  number: 302
                  neighborhood: Vila Olímpia
                  complement: Torre B
                  city: São Paulo
                  state: SP
                  country: Brasil
              subscription:
                interval: 30
                code: plano_mensal_001
                description: Plano Mensal Premium
                installments: 1
                max_invoices: 12
                minimum_price: 9990
                billing_type: prepaid
                discounts:
                  cycles: 1
                  value: 10
                  type: percentage
                metadata:
                  origem: site
              payment:
                type: CreditCard
                card:
                  number: '4111111111111111'
                  name: CARLOS FERREIRA
                  month: '08'
                  year: '28'
                  security_code: '456'
              items:
                - id: plano_premium
                  description: Acesso Premium Mensal
                  amount: 99.9
                  quantity: 1
      responses:
        '200':
          description: Assinatura criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  parameters:
    AccountHeader:
      name: account
      in: header
      required: true
      description: Código da conta à qual a operação se aplica
      schema:
        type: string
        example: acc_abc123xyz
  schemas:
    StoreSubscriptionRequest:
      type: object
      required:
        - client
        - subscription
        - payment
        - items
      properties:
        international:
          type: boolean
          nullable: true
          description: Indica se é uma transação internacional (opcional)
          example: false
        client:
          $ref: '#/components/schemas/ClientDataWithIp'
        subscription:
          $ref: '#/components/schemas/SubscriptionData'
        payment:
          $ref: '#/components/schemas/PaymentDataSubscription'
        items:
          type: array
          description: Lista de itens da assinatura (obrigatório)
          items:
            $ref: '#/components/schemas/ItemData'
    SubscriptionResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Assinatura criada com sucesso
        data:
          type: object
          properties:
            subscription_code:
              type: string
              example: sub_abc123
            status:
              type: string
              enum:
                - Active
                - Canceled
                - Suspended
                - Completed
              example: Active
            interval:
              type: integer
              description: Intervalo de cobrança em dias
              example: 30
            payment_method:
              type: string
              example: CreditCard
            next_billing_date:
              type: string
              format: date
              example: '2026-04-11'
            created_at:
              type: string
              format: date-time
              example: '2026-03-11T10:00:00.000000Z'
    ClientDataWithIp:
      allOf:
        - $ref: '#/components/schemas/ClientData'
        - type: object
          properties:
            client_ip:
              type: string
              format: ipv4
              description: Endereço IP do cliente (opcional)
              example: 192.168.1.100
    SubscriptionData:
      type: object
      required:
        - interval
      properties:
        interval:
          type: integer
          description: Intervalo de cobrança em dias (obrigatório, 1-365)
          minimum: 1
          maximum: 365
          example: 30
        code:
          type: string
          nullable: true
          description: >-
            Código identificador da assinatura (opcional, definido pelo
            integrador)
          example: plano_mensal_001
        description:
          type: string
          nullable: true
          description: Descrição da assinatura (opcional)
          example: Plano Mensal Premium
        installments:
          type: integer
          nullable: true
          description: Parcelas por cobrança (obrigatório se CreditCard, 1-12)
          minimum: 1
          maximum: 12
          example: 1
        max_invoices:
          type: integer
          nullable: true
          description: Número máximo de faturas a serem geradas (opcional, mín. 1)
          minimum: 1
          example: 12
        minimum_price:
          type: integer
          nullable: true
          description: Preço mínimo em centavos (opcional)
          example: 9990
        start_date:
          type: string
          nullable: true
          description: >-
            Data de início da cobrança (opcional, formato `Y-m-d H:i:s`, deve
            ser após amanhã)
          example: '2026-04-01 00:00:00'
        billing_type:
          type: string
          nullable: true
          description: Tipo de cobrança da assinatura (opcional)
          enum:
            - prepaid
          example: prepaid
        billing_day:
          type: integer
          nullable: true
          description: >-
            Dia do mês para cobrança (obrigatório se billing_type=exact_day,
            1-31)
          minimum: 1
          maximum: 31
          example: 10
        discounts:
          type: object
          nullable: true
          description: Desconto a ser aplicado nas faturas (opcional)
          properties:
            cycles:
              type: integer
              description: Número de ciclos com desconto
              example: 3
            value:
              type: number
              description: Valor do desconto
              example: 10
            type:
              type: string
              description: Tipo do desconto
              enum:
                - percentage
                - flat
              example: percentage
        increments:
          type: object
          nullable: true
          description: Acréscimo a ser aplicado nas faturas (opcional)
          properties:
            cycles:
              type: integer
              example: 2
            value:
              type: number
              example: 5
            type:
              type: string
              enum:
                - percentage
                - flat
              example: flat
        metadata:
          type: object
          nullable: true
          description: Metadados adicionais em formato livre (opcional)
          example:
            origem: site
            campanha: black-friday
    PaymentDataSubscription:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          description: Método de pagamento (obrigatório, CreditCard ou PIX)
          enum:
            - CreditCard
            - PIX
          example: CreditCard
        pix_expiration:
          type: integer
          nullable: true
          description: Expiração do PIX em segundos (obrigatório se type=PIX)
          example: 3600
        card:
          type: object
          nullable: true
          description: Dados do cartão (obrigatório)
          properties:
            number:
              type: string
              description: Número do cartão (mín. 13 dígitos)
              example: '4111111111111111'
            name:
              type: string
              description: Nome no cartão
              example: CARLOS FERREIRA
            month:
              type: string
              description: Mês de validade
              example: '08'
            year:
              type: string
              description: Ano de validade
              example: '28'
            security_code:
              type: string
              description: CVV
              example: '456'
            soft_descriptor:
              type: string
              nullable: true
              description: Texto na fatura (opcional, máx. 50 caracteres)
              example: MINHA EMPRESA
    ItemData:
      type: object
      required:
        - id
        - description
        - amount
        - quantity
      properties:
        id:
          type: string
          description: Referência externa do item (obrigatório)
          example: produto_001
        description:
          type: string
          description: Descrição do item (obrigatório, máx. 255 caracteres)
          maxLength: 255
          example: Camiseta Premium
        amount:
          type: number
          format: float
          description: >-
            Valor unitário do item (obrigatório). Para testes em PIX, valores
            acima de R$ 300,00 pode resultar em erro.
          example: 99.9
        quantity:
          type: integer
          description: Quantidade do item (obrigatório)
          minimum: 1
          example: 2
    ErrorResponse:
      type: object
      properties:
        mensagem:
          type: string
          example: Um erro inesperado acabou de acontecer.
        erro:
          type: boolean
          example: true
        mensagenserro:
          type: array
          items:
            type: string
          example:
            - Detalhe do erro ocorrido.
        codigoretorno:
          type: integer
          example: 400
        id:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        data:
          type: array
          example: []
    ValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: The given data was invalid.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            client.email:
              - O campo client.email é obrigatório.
            payment.type:
              - O campo payment.type é obrigatório.
    ClientData:
      type: object
      required:
        - name
        - email
        - phone
      properties:
        name:
          type: string
          description: Nome completo do cliente (obrigatório, máx. 255 caracteres)
          example: João Silva
        email:
          type: string
          format: email
          description: E-mail do cliente (obrigatório)
          example: joao@exemplo.com.br
        gender:
          type: string
          description: Gênero do cliente (opcional)
          enum:
            - Male
            - Female
            - Other
            - Undefined
          example: Male
        birthdate:
          type: string
          format: date
          description: Data de nascimento no formato YYYY-MM-DD (opcional)
          example: '1990-01-15'
        phone:
          $ref: '#/components/schemas/PhoneData'
        document:
          $ref: '#/components/schemas/DocumentData'
        address:
          $ref: '#/components/schemas/AddressData'
    PhoneData:
      type: object
      required:
        - ddi
        - ddd
        - number
      properties:
        ddi:
          type: string
          description: Código do país (DDI) — obrigatório
          example: '55'
        ddd:
          type: string
          description: Código de área (DDD) — obrigatório
          example: '11'
        number:
          type: string
          description: Número do telefone sem DDD — obrigatório
          example: '999999999'
    DocumentData:
      type: object
      properties:
        type:
          type: string
          description: >-
            Tipo do documento (opcional para checkout, obrigatório para
            assinaturas)
          enum:
            - CPF
            - CNPJ
            - passport
            - undefined
          example: CPF
        number:
          type: string
          description: >-
            Número do documento (opcional para checkout, obrigatório para
            assinaturas)
          example: 123.456.789-09
    AddressData:
      type: object
      description: Endereço do cliente (obrigatório se o objeto address for enviado)
      properties:
        zipcode:
          type: string
          description: CEP (obrigatório quando address é enviado)
          example: 01310-100
        street:
          type: string
          description: Logradouro (obrigatório quando address é enviado)
          example: Avenida Paulista
        number:
          type: integer
          description: Número do endereço (obrigatório quando address é enviado)
          example: 1000
        neighborhood:
          type: string
          description: Bairro (obrigatório quando address é enviado, máx. 255 caracteres)
          example: Bela Vista
        complement:
          type: string
          description: >-
            Complemento (obrigatório quando address é enviado, máx. 255
            caracteres)
          example: Apto 42
        city:
          type: string
          description: Cidade (obrigatório quando address é enviado, máx. 255 caracteres)
          example: São Paulo
        state:
          type: string
          description: UF com 2 letras (obrigatório quando address é enviado)
          maxLength: 2
          example: SP
        country:
          type: string
          description: País (opcional, máx. 255 caracteres)
          example: Brasil
  responses:
    Unauthorized:
      description: Não autorizado — token inválido ou ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            mensagem: Unauthenticated.
            erro: true
            mensagenserro: []
            codigoretorno: 401
            id: 00000000-0000-0000-0000-000000000000
            data: []
    ValidationError:
      description: Erro de validação dos dados enviados
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            message: The given data was invalid.
            errors:
              client.email:
                - O campo client.email é obrigatório.
    ServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            mensagem: Um erro aconteceu.
            erro: true
            mensagenserro:
              - Erro interno. Tente novamente mais tarde.
            codigoretorno: 500
            id: 00000000-0000-0000-0000-000000000000
            data: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
        Bearer <token>`.

````