PApagar

Criar plano

Este recurso possibilita a criação de um plan que poderá ser utilizado futuramente para a criação de uma assinatura. Para mais detalhes consulte a pagina principal do objeto.

post/plans

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/plans
  • Auth
    HTTP basic

Request body

namestring required

Nome do plano. Max: 64 caracteres.

descriptionstring

Descrição do plano.

shippableboolean

Indica se o plano oferece entrega.

payment_methodsstring[]

Meios de pagamento disponíveis para assinaturas criadas a partir do plano. <br>Valores possíveis: credit_card, boleto ou debit_card. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será credit_card

installmentsinteger[]

Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.<br>Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista. O número de parcelas deverá ser 1 em recorrências.

minimum_priceinteger

Valor mínimo em centavos da fatura.

statement_descriptorstring

Texto exibido na fatura do cartão. <br>Será aplicado para assinaturas de cartão de crédito criadas a partir do plano. Max: 13 caracteres.

currencystring

Moeda. Valores possíveis: BRL.

intervalstring

Frequência da recorrência. Valores possíveis: day,week, month ou year.

interval_countinteger

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. <br>Ex.: plano mensal = interval_count (1) e interval (month) <br> plano trimestral = interval_count (3) e interval (month) <br> plano semestral = interval_count (6) e** interval** (month)

trial_period_daysinteger

Dias de teste. A assinatura será iniciada após o término deste período.

billing_typestring

Tipo de cobrança. Valores possíveis: prepaid, **postpaid **ou exact_day.

billing_daysinteger[]

Dias disponíveis para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. Obrigatório, caso o billing_type seja igual a exact_day.

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.<br>Saiba mais sobre metadata

quantityinteger

Quantidade para o pricing_scheme.<br>Obrigatório quando o pricing_scheme.scheme_type for igual a unit.

Response

200

Changes

No recorded changes to this operation across all 2 revisions of this API.