---
agentTools:
  projectIndex: https://docs.mundipagg.com/llms.txt
---

# Planos

O objeto `plan` representa um _template_ pré-definido de assinatura, isto é, um **plano**, que facilita a criação de uma nova assinatura para um cliente. Saiba mais sobre planos acessando nossa [documentação](https://docs.mundipagg.com/docs/plano). O objeto `plan` possui os seguintes atributos:

[block:parameters]
{
  "data": {
    "0-0": "`id`",
    "1-0": "`name`",
    "2-0": "`description`",
    "3-0": "`currency`",
    "4-0": "`interval`",
    "5-0": "`interval_count`",
    "7-0": "`billing_type`",
    "8-0": "`billing_days`",
    "9-0": "`payment_methods`",
    "10-0": "`installments`",
    "11-0": "`statement_descriptor`",
    "12-0": "`trial_period_days`",
    "13-0": "`status`",
    "14-0": "`shippable`",
    "15-0": "`created_at`",
    "16-0": "`updated_at`",
    "17-0": "`deleted_at`",
    "18-0": "`items`",
    "19-0": "`minimum_price`",
    "0-1": "**string**",
    "1-1": "**string**",
    "2-1": "**string**",
    "3-1": "**enum**",
    "4-1": "**enum**",
    "5-1": "**integer**",
    "7-1": "**enum**",
    "8-1": "**array of integers**",
    "9-1": "**array of strings**",
    "10-1": "**array of integers**",
    "11-1": "**string**",
    "12-1": "**integer**",
    "13-1": "**enum**",
    "14-1": "**boolean**",
    "15-1": "**datetime**",
    "16-1": "**datetime**",
    "17-1": "**datetime**",
    "18-1": "**array of objects**",
    "19-1": "**int**",
    "0-2": "_Código do plano_. Formato: `plan_XXXXXXXXXXXXXXXX`.",
    "1-2": "_Nome do plano_.",
    "2-2": "_Descrição do plano_.",
    "3-2": "_Moeda_. Valores possíveis: `BRL`,  `ARS`,  `BOB`,  `CLP`,  `COP `,  `MXN`,  `PYG`,  `USD `,  `UYU` e `EUR`.",
    "4-2": "_Frequência da recorrência_. Valores possíveis: `day`,`week`, `month` ou `year`.",
    "5-2": "_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).",
    "7-2": "_Tipo de cobrança_. Valores possíveis: `prepaid`, `postpaid `ou `exact_day`.",
    "8-2": "_Dias disponíveis para cobrança das assinaturas criadas a partir do plano_.",
    "9-2": "_Meios de pagamento disponíveis para assinaturas criadas a partir do plano_. Valores possíveis: `credit_card`,  `boleto` ou `cash`.",
    "10-2": "_Opções de parcelamento disponíveis para assinaturas criadas a partir do plano_. Disponível apenas caso o meio de pagamento da assinatura seja `credit_card`.",
    "11-2": "_Texto exibido na fatura do cartão_.",
    "12-2": "_Número de dias de trial_. O cliente só será cobrado após esse período, quando a assinatura será iniciada.",
    "13-2": "_Status do plano_. Valores possíveis: `active`, `inactive` ou `deleted`.",
    "14-2": "_Indica se o produto oferecido pelo plano é passível de entrega_. Por exemplo, planos relacionados a serviços não possuem dados para entrega.",
    "15-2": "_Data de criação do plano_.",
    "16-2": "_Data de atualização do plano_.",
    "17-2": "_Data de exclusão do plano_.",
    "18-2": "_Itens do plano_.[Saiba mais sobre itens do plano](https://docs.mundipagg.com/v1/reference#item-do-plano).",
    "19-2": "_Valor mínimo do plano_.",
    "h-0": "Atributos",
    "h-1": "Tipo",
    "h-2": "Descrição",
    "20-0": "`metadata`",
    "20-1": "**object**",
    "20-2": "_Informações adicionais sobre o plano_. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata).",
    "6-0": "`minimum_price`",
    "6-1": "**integer**",
    "6-2": "_Valor mínimo em centavos da da assinatura_."
  },
  "cols": 3,
  "rows": 21
}
[/block]