v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar plano

Com o verbo HTTP PUT, através do identificador do plano (plan_id) é possível atualizar os dados do plano.

put/plans/{plan_id}

Path parameters

plan_idstring required

Código do Plano. Formato: plan_XXXXXXXXXXXXXXXX.

Request body

namestring required

Nome do plano. Max: 64 caracteres.

descriptionstring

Descrição do plano. Max: 256 caracteres

currencystring required

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

intervalstring required

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

interval_countinteger required

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

billing_typestring required

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

billing_daysinteger[]

Dias disponíveis para cobrança. Obrigatório, caso o billing_type seja igual a exact_day.

installmentsinteger[]

Opções de parcelamento disponíveis para assinaturas criadas a partir do plano. Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista.

statement_descriptorstring

Texto exibido na fatura do cartão. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. Max: 22 caracteres.

minimum_priceinteger

Valor mínimo em centavos do plano.

statusstring required

Status do plano. Valores possíveis: active, inactive ou deleted

shippableboolean

Indica se o produto oferecido pelo plano é entregável. Por exemplo, planos relacionados a serviços não possuem dados para entrega.

payment_methodsstring[] required

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

trial_period_daysinteger

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

metadataobject

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

Response

200

idstring

namestring

descriptionstring

urlstring

currencystring

intervalstring

interval_countinteger

billing_typestring

installmentsinteger

statement_descriptorstring

statusstring

created_atstring

updated_atstring

minimum_priceinteger

Example response

{
  "id": "plan_21r4CTG0ux77Qv13",
  "name": "Plano Gold",
  "description": "Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.",
  "url": "/plan_21r4CTG0ux77Qv13/academia/plano-silver",
  "currency": "BRL",
  "interval": "month",
  "interval_count": 3,
  "billing_type": "prepaid",
  "installments": 3,
  "statement_descriptor": "SILVER",
  "status": "active",
  "created_at": "2016-07-12T18:25:40Z",
  "updated_at": "2016-07-12T18:25:40Z",
  "minimum_price": 10000,
  "items": [
    {
      "id": "pi_3j1EG9ousipHjcUL",
      "name": "Musculação",
      "status": "active",
      "created_at": "2016-07-12T18:25:40Z",
      "updated_at": "2016-07-12T18:25:40Z",
      "pricing_scheme": {
        "price": 18990,
        "scheme_type": "unit"
      }
    }
  ],
  "metadata": {
    "id": "my_plan_id"
  }
}