> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Criar um plano de assinatura > Cria uma oferta recorrente: o comprador é cobrado no intervalo escolhido até cancelar, ou por um número fixo de cobranças. Só vale para produto digital com cobrança de assinatura; qualquer outro caso responde 400. ## OpenAPI ````yaml /openapi.yaml post /v1/products/{productId}/offer-plans openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/products/{productId}/offer-plans: post: tags: - Catálogo summary: Criar um plano de assinatura description: >- Cria uma oferta recorrente: o comprador é cobrado no intervalo escolhido até cancelar, ou por um número fixo de cobranças. Só vale para produto digital com cobrança de assinatura; qualquer outro caso responde 400. operationId: createOfferPlan parameters: - schema: type: string minLength: 1 in: path name: productId required: true description: Identificador do produto dono da oferta. requestBody: required: true content: application/json: schema: type: object properties: title: type: string minLength: 2 maxLength: 200 description: Nome do plano no checkout. price: type: integer minimum: 500 description: Valor de cada cobrança, em centavos. frequency: type: string enum: - weekly - monthly - bimonthly - quarterly - semiannual - annual description: Intervalo entre as cobranças do plano. renewalType: type: string enum: - until_cancelled - fixed_charges description: Renova até o cancelamento ou para depois de N cobranças. maxCharges: type: integer exclusiveMinimum: true minimum: 0 description: Número de cobranças quando `renewalType` é `fixed_charges`. hasDifferentFirstPrice: type: boolean default: false description: A primeira cobrança tem valor próprio. firstChargePrice: type: integer minimum: 500 description: Valor da primeira cobrança, em centavos. admissionFeePrice: type: integer exclusiveMinimum: true minimum: 0 description: Taxa de adesão somada só à primeira cobrança, em centavos. promotional: type: boolean description: Marca o plano como promoção. compareAtPrice: type: integer exclusiveMinimum: true minimum: 0 nullable: true description: Preço "de" riscado, em centavos. expiresAt: type: string format: date-time nullable: true description: Momento em que o plano para de aceitar novas assinaturas. required: - title - price - frequency - renewalType additionalProperties: false example: title: Mentoria de Copywriting — Mensal price: 19900 frequency: monthly renewalType: until_cancelled hasDifferentFirstPrice: true firstChargePrice: 24900 admissionFeePrice: 5000 responses: '201': description: Plano de assinatura criado. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: integer description: Identificador da oferta. productId: type: string description: Produto ao qual a oferta pertence. title: type: string description: Nome da oferta exibido no checkout. slug: type: string description: >- Identificador curto usado na URL do checkout desta oferta. price: type: integer description: Preço em centavos (R$ 499,00 = 49900). compareAtPrice: type: integer nullable: true description: >- Preço "de" riscado ao lado do preço atual, em centavos. sku: type: string nullable: true description: Código interno do vendedor para esta oferta. paymentMethods: type: array items: type: string enum: - pix - credit_card - boleto - multiple_cards description: Meios de pagamento aceitos nesta oferta. active: type: boolean description: Oferta disponível para compra. isDefault: type: boolean description: >- Oferta pré-selecionada quando o comprador abre o checkout. promotional: type: boolean description: Oferta marcada como promoção na vitrine do checkout. hiddenFromAffiliates: type: boolean description: Oferta escondida do painel dos afiliados. sortOrder: type: integer description: Posição da oferta na lista do checkout. expiresAt: type: string format: date-time nullable: true description: Momento em que a oferta deixa de ser vendável. frequency: type: string enum: - weekly - monthly - bimonthly - quarterly - semiannual - annual nullable: true description: >- Intervalo de cobrança do plano; `null` em oferta de pagamento único. renewalType: type: string enum: - until_cancelled - fixed_charges nullable: true description: >- Renovação do plano: até o cancelamento ou número fixo de cobranças. maxCharges: type: integer nullable: true description: >- Quantas cobranças o plano faz quando a renovação é fixa. hasDifferentFirstPrice: type: boolean description: A primeira cobrança do plano tem valor próprio. firstChargePrice: type: integer nullable: true description: Valor da primeira cobrança, em centavos. admissionFeePrice: type: integer nullable: true description: >- Taxa de adesão somada só à primeira cobrança, em centavos. createdAt: type: string format: date-time description: Momento de criação da oferta. updatedAt: type: string format: date-time description: Momento da última alteração da oferta. required: - id - productId - title - slug - price - compareAtPrice - sku - paymentMethods - active - isDefault - promotional - hiddenFromAffiliates - sortOrder - expiresAt - frequency - renewalType - maxCharges - hasDifferentFirstPrice - firstChargePrice - admissionFeePrice - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Plano de assinatura criado. example: success: true data: id: 4822 productId: clx8a2h4k0001qz0a1b2c3d4e title: Mentoria de Copywriting — Mensal slug: copywriting-mensal price: 19900 compareAtPrice: null sku: null paymentMethods: - credit_card active: true isDefault: true promotional: false hiddenFromAffiliates: false sortOrder: 0 expiresAt: null frequency: monthly renewalType: until_cancelled maxCharges: null hasDifferentFirstPrice: true firstChargePrice: 24900 admissionFeePrice: 5000 createdAt: '2026-09-01T13:45:00.000Z' updatedAt: '2026-09-10T08:12:00.000Z' '400': description: A requisição está bem formada, mas uma regra de negócio a recusou. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- A requisição está bem formada, mas uma regra de negócio a recusou. example: success: false message: >- Não foi possível concluir: uma regra de negócio recusou os dados enviados. '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Recurso não encontrado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````