v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Criar Plano

Cria um plano.

post/plans

Request body

namestring required

Nome do plano

identifierstring required

Identificador do plano

intervalinteger required

Ciclo do plano (Entre 1 e 599). Intervalo até a próxima cobrança.

interval_typestring required

Tipo de interval ("weeks" ou "months").

value_centsinteger required

Preço do plano em centavos

payable_withstring[]

Método de pagamento que será disponibilizado para as faturas pertencentes a assinaturas deste plano ('all', 'credit_card', 'bank_slip' ou 'pix')

billing_daysinteger

Dias de faturamento (Quantos dias antes de vencer a assinatura será gerada uma nova fatura)

max_cyclesinteger

Limite de ciclos da assinatura - 0 para indeterminado

invoice_max_installmentsinteger

Envie um valor de '1' à '12'. Se este parâmetro não for enviado, a quantidade máxima de parcelas será o que está configurado na conta.

Response

200

idstring

namestring

identifierstring

intervalinteger

interval_typestring

created_atstring

updated_atstring

payable_withstring[]

max_cyclesinteger

billing_daysinteger

{"stackTrail":"paths:/plans:post:responses:200:content:application/json:schema:properties:invoice_max_installments","oasType":"schema","type":"unknown"}

Example response

{
  "id": "CA1D0620A8434B2CABFF951A72EA70D6",
  "name": "Plano Master",
  "identifier": "master_plan",
  "interval": 1,
  "interval_type": "months",
  "created_at": "2025-04-03T11:51:28-03:00",
  "updated_at": "2025-04-03T11:51:28-03:00",
  "prices": [
    {
      "id": "E11DC66A12414F2DB1EC78A9FDEF0C55",
      "currency": "BRL",
      "value_cents": 1,
      "plan_id": "CA1D0620A8434B2CABFF951A72EA70D6",
      "created_at": "2025-04-03T11:51:28-03:00",
      "updated_at": "2025-04-03T11:51:28-03:00"
    }
  ],
  "features": [
    {
      "id": "1610B2CBF9504CA5BAD1FEB328953A3B",
      "name": "2 aulas individuais por semana",
      "identifier": "2_classes_per_week",
      "value": 1,
      "plan_id": "CA1D0620A8434B2CABFF951A72EA70D6",
      "position": 1,
      "created_at": "2025-04-03T11:51:28-03:00",
      "updated_at": "2025-04-03T11:51:28-03:00"
    }
  ],
  "payable_with": [
    "pix"
  ],
  "billing_days": 5
}