Criar oferta

post

https://sua-plataforma.ensinio.cloud/public/api/v1/groups/{groupId}/offers

Cria uma oferta ativa e já vinculada ao grupo, e devolve o link de checkout gerado.

Este endpoint precisa estar habilitado no seu plano.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

groupId

integer

required

ID do grupo

Body Params

Campos comuns à criação e à edição.

title

string

required

length ≤ 255

description

string | null

price

number

required

≤ 100000

Valor da oferta. Na recorrente, é o valor da frequência informada em frequency.

payment_type

string

enum

required

unique pagamento único · recurrent assinatura · carne carnê

Allowed:

frequency

string

enum

Allowed:

max_installments

integer

≥ 1

No cartão (único e recorrente): o máximo de parcelas, de 1 a 12. Padrão 1.
No carnê: o número de parcelas, de 1 a 24, sem passar do valor da oferta (nenhuma
parcela abaixo de R$ 1).

free_installments

integer

1 to 12

Quantidade de parcelas sem juros no cartão. Padrão 1. No carnê é ignorado: toda
parcela é sem juros.

carne_delinquency_condition

string

enum

Só no carnê: quando o aluno perde o acesso por inadimplência e como o recupera.

Allowed:

payment_methods

array of objects, unique

length ≥ 1

Métodos aceitos. Padrão, os três. Na edição, a lista substitui a atual.

enable_expiration

boolean

Liga a expiração do acesso do aluno. Padrão false. Sem true, o acesso é
vitalício, mesmo que o tipo e o valor da expiração venham. Não se aplica à
recorrente, em que o acesso dura enquanto a assinatura estiver paga.

expiration_type

string

enum

fixed_date expira na data expiration_date; relative_to_start expira
expiration_count expiration_interval depois da compra. Quando não vem, é
deduzido: expiration_date indica data fixa; expiration_count com
expiration_interval, a partir da compra.

Allowed:

expiration_date

date

Obrigatório na expiração em data fixa.

expiration_count

integer

≥ 1

Obrigatório na expiração a partir da compra.

expiration_interval

string

enum

Obrigatório na expiração a partir da compra.

Allowed:

visibility

string

enum

Padrão public.

Allowed:

redirect_type

string

enum

Página de obrigado: default usa a da plataforma; custom redireciona para
redirect_url. Padrão default.

Allowed:

redirect_url

uri | null

Obrigatório quando redirect_type é custom.

checkout_format

string

enum

Formato do checkout: em etapas ou em uma página. Só são aceitos os formatos
habilitados na plataforma. Padrão steps.

Allowed:

Responses

401

Token da integração ausente ou inválido

405

As ofertas não estão habilitadas nesta plataforma

429

Limite de requisições excedido

201Oferta criada

403Recurso não habilitado no plano da plataforma

404Grupo não encontrado (ou arquivado)

422Erro de validação, com o nome do campo enviado em errors