Sign in

v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Criar plano

post/plans

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

x-idempotency-keystring

Chave composta de caracteres alfanumérico, exceto caracteres especiais. As chaves são recicladas depois de um intervalo não específico. Com isso, é garantido sua eficiência por 48 horas (MAX 200 caracteres).

Request body

reference_idstring

Identificador único atribuído para o plano. Utilizado internamente pelo vendedor em seu sistema (Max 65 caracteres).

namestring

Nome do plano na sua aplicação (Max 65 caracteres). ⚠️ Obrigatório ⚠️

descriptionstring

Descrição do plano na sua aplicação (Max 250 caracteres).

setup_feeinteger

Taxa de contratação a ser cobrada na assinatura especificada em centavos de Real. Se não desejar cobrar uma taxa de contratação para o plano, o campo setup_fee deve ser deixado em branco ou não enviado como atributo (Max 9 caracteres).

billing_cyclesinteger

Quantidade de ciclos (faturas) que a assinatura terá até expirar. Não informar este campo para que não haja expiração.

limit_subscriptionsinteger

Quantidade máxima de assinaturas do plano. Para não haver limite, deixar esse campo em branco.

payment_methodstring[]

Formas de pagamentos aceitas no plano. Caso o atributo não seja informado, a forma de pagamento default é CREDIT_CARD. <br> <small>Exemplos: BOLETO, CREDIT_CARD</small>.

editableboolean

Sinaliza se o plano criado poderá ser alterado após a criação. Por padrão, esse parâmetro é considerado true.

Response

200

object required