Sign in

v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Criar plano

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

post/plans

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.

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.

currencystring

Moeda. Valores possíveis: BRL, ARS, BOB, CLP, **COP **, MXN, PYG, **USD **, UYU e EUR.

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[] required

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.

metadataobject

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

Response

200

idstring
namestring
urlstring
minimum_priceinteger
intervalstring
interval_countinteger
billing_typestring
payment_methodsstring[]
installmentsinteger[]
statusstring
currencystring
created_atstring
updated_atstring

Example response

{
  "id": "plan_0z5Jd4dFk3t9Jo4m",
  "name": "Plano Gold",
  "url": "plans/plan_0z5Jd4dFk3t9Jo4m/simu/plano-gold",
  "minimum_price": 10000,
  "interval": "month",
  "interval_count": 3,
  "billing_type": "prepaid",
  "payment_methods": [
    "credit_card"
  ],
  "installments": [
    3
  ],
  "status": "active",
  "currency": "BRL",
  "created_at": "2019-01-22T17:24:02Z",
  "updated_at": "2019-01-22T17:24:02Z",
  "items": [
    {
      "id": "pi_d97LMgRCmOFdWREe",
      "name": "Musculação",
      "quantity": 1,
      "status": "active",
      "created_at": "2019-01-22T17:24:02Z",
      "updated_at": "2019-01-22T17:24:02Z",
      "pricing_scheme": {
        "price": 18990,
        "scheme_type": "unit"
      }
    }
  ],
  "metadata": {
    "id": "my_plan_id"
  }
}