Criar plano de assinatura

post

https://api.autra.io/v1/acquiring/subscription-plans

Cria um plano do estabelecimento: quanto cobrar, de quanto em quanto tempo, por quais meios e quando vence a 1ª cobrança. Assinaturas de clientes finais são criadas sobre um plano ativo.

Regras

O nome é único por estabelecimento (sem diferenciar maiúsculas e espaços nas pontas).
Valor, periodicidade, meios e regras são imutáveis. Para mudar o preço, crie outro plano e arquive o antigo; as assinaturas existentes seguem no plano delas.
firstDue.rule = FIXED_DAY exige billingDay (1–31) e não aceita offsetDays; DAYS_AFTER_ENROLLMENT exige offsetDays (0–365) e não aceita billingDay.
cardRetryDays define as novas tentativas no cartão depois de uma recusa (padrão [1, 3, 7] dias após o vencimento). Cada fatura tem até 3 tentativas: o vencimento e as duas primeiras da lista.
A cobrança automática desta versão é no cartão (CARD).

Exige a feature subscriptions no tenant.

Erros — corpo {"errors":[{"code":"...","msg":"..."}]}; msg detalha o campo quando é validação:

`code`	HTTP	Quando acontece	O que fazer
`INVALID_INPUT`	400	Campo inválido ou fora do limite; `msg` diz qual e a regra.	Corrija o campo indicado.
`INVALID_JSON`	400	Corpo não é um objeto JSON válido.	Corrija o JSON.
`MISSING_DOCUMENT_ID`	400	Estabelecimento não informado.	Envie o header `X-Merchant-Document` (ou `documentId`).
`TENANT_REQUIRED`	400	A credencial não identifica o tenant.	Gere o token com as credenciais do seu tenant (`POST /v1/oauth/token`).
`FEATURE_DISABLED`	403	O módulo de assinaturas não está habilitado para o tenant.	Peça a habilitação à Autra.
`MERCHANT_NOT_FOUND`	404	O documento não é de um estabelecimento do seu tenant.	Confira o CPF/CNPJ do estabelecimento.
`PLAN_NAME_IN_USE`	409	Já existe plano com este nome no estabelecimento.	Use outro nome ou reaproveite o plano existente.
`PAYLOAD_TOO_LARGE`	413	Corpo acima de 64 KiB.	Reduza o corpo da requisição.
`INVALID_DOCUMENT`	422	Documento do estabelecimento malformado.	CPF com 11 ou CNPJ com 14 dígitos, só números.
`INTERNAL_ERROR`	500	Falha interna.	Tente de novo; persistindo, fale com o suporte com o horário da chamada.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

documentId

string

CPF/CNPJ do estabelecimento, quando não usar o header nem o corpo

Body Params

Plano

allowedMethods

array of strings, unique

required

Meios de pagamento aceitos no plano (ao menos um, sem repetição). A cobrança automática desta versão é no cartão (CARD); PIX_AUTOMATIC e PIX ficam registrados para as próximas fases.

amount

number

required

Valor de cada cobrança em reais, maior que zero, até 2 casas decimais (máximo 1.000.000,00). Imutável: preço novo é plano novo. Para mudar o valor de uma assinatura existente sem novo cadastro do cartão, troque-a de plano com POST /v1/acquiring/subscriptions/{id}/change-plan.

cardRetryDays

array of integers

Dias, contados do vencimento, das novas tentativas no cartão depois de uma recusa: 1 a 3 valores crescentes entre 1 e 30. Omitido = [1, 3, 7]. São 3 tentativas no total por fatura (o vencimento + as 2 primeiras destas).

cardRetryDays

documentId

string

Documento do estabelecimento (CPF ou CNPJ, só números). Alternativa ao header X-Merchant-Document, que tem precedência.

enrollmentCharge

string

enum

required

FIRST_DUE_DATE: a adesão só cadastra o cartão (valor zero) e a 1ª cobrança é no 1º vencimento. IMMEDIATE: o 1º vencimento é o dia da assinatura.

Allowed:

firstDue

object

required

Regra do 1º vencimento.

name

string

required

length ≤ 120

Nome do plano, único por estabelecimento (sem diferenciar maiúsculas e espaços nas pontas). 1 a 120 caracteres.

periodicity

string

enum

required

Intervalo entre cobranças.

Allowed:

pixGraceDays

integer

0 to 60

Carência em dias para Pix por fatura (0 a 60). Omitido = 3. Não afeta cartão.

Headers

X-Merchant-Document

string

CPF/CNPJ do estabelecimento (só números). Preferido; alternativa: documentId no corpo ou na query

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400INVALID_INPUT, INVALID_JSON, MISSING_DOCUMENT_ID, TENANT_REQUIRED

403FEATURE_DISABLED

404MERCHANT_NOT_FOUND

409PLAN_NAME_IN_USE

413PAYLOAD_TOO_LARGE

422INVALID_DOCUMENT

500INTERNAL_ERROR