Criar plano | Dom Docs

Este recurso cria um plan que poderá ser utilizado futuramente para a criação de uma assinatura.

POST{apiUrl}/recurrence/plan

URL base da API

Token de autenticação

Body Params

descriptionstringrequired

Descrição do nome do plano. Máximo 80 caracteres.

valuenumberrequired

Valor padrão do plano.

frequencyintegerrequired

Indica o valor de frequency. Junto com frequency_type define o ciclo de cobrança que a assinatura terá.

frequency_typestringrequired

Indica o tipo de frequency. Junto com frequency, exemplos: Para cobrar mensalmente, defina frequency = 1 e frequency_type = MONTH

payment_methodsarrayrequired

Meios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: credit_card

external_referencestringoptional

Código de referência da loja

repetitionsintegeroptional

É opcional e utilizado para criar uma assinatura limitada. Indica o número de cobranças que serão repetidos no ciclo de recorrência. Ex: para cobrar no máximo 6 meses de uma recorrência mensal, defina frequency = 1, frequency_type = MONTH e repetitions = 6

billing_typestringoptional

Tipo de cobrança: prepaid, postpaid ou exact_day (default: prepaid)

billing_dayintegeroptional

Dia disponível para cobrança das assinaturas (1–28). Obrigatório caso billing_type seja exact_day.

retry_daysintegeroptional

Quantidade de dias para retentativa da cobrança após a data do processamento da fatura (default: 0)

trial_period_daysintegeroptional

Dias para iniciar a cobrança da assinatura (default: 0)

installmentsintegeroptional

Quantidade de parcelas permitidas para parcelamento da fatura quando o tipo de pagamento for credit_card

curl --request POST \
  --url "{apiUrl}/recurrence/plan" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Campos da resposta

idstring

Identificador único do plano (UUID)

descriptionstring

Nome/descrição do plano

valuenumber

Valor padrão do plano

external_referencestring

Código de referência da loja

frequencyinteger

Valor numérico da frequência

frequency_typestring

Tipo de frequência: DAY, MONTH, YEAR ou WEEK

repetitionsinteger

Número máximo de cobranças (0 = ilimitado)

payment_methodsarray

Métodos de pagamento disponíveis

installmentsinteger

Parcelas permitidas no crédito

billing_typestring

Tipo de cobrança: prepaid, postpaid ou exact_day

billing_dayinteger

Dia do mês para cobrança

trial_period_daysinteger

Dias de trial antes da primeira cobrança

retry_daysinteger

Dias para retentativa após falha

statusstring

Status do plano: active ou inactive

created_atstring

Data de criação (ISO 8601)