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 Pagina de Guias. O objeto plan possui os seguintes atributos:

Para visualizar as informações de negócio consulte o nosso Guia.

AtributosTipoDescrição
idstringCódigo do plano. Formato: plan_XXXXXXXXXXXXXXXX.
namestringNome do plano.
descriptionstringDescrição do plano.
currencyenumMoeda. Valores possíveis: BRL.
intervalenumFrequência da recorrência. Valores possíveis: day,week, month ou year.
interval_countintegerNú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).
minimum_priceintegerValor mínimo em centavos da assinatura.
billing_typeenumTipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.
billing_daysarray of integersDias disponíveis para cobrança das assinaturas criadas a partir do plano.
payment_methodsarray of stringsMeios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: credit_card, boleto ou cash.
installmentsarray of integersOpçõ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.
statement_descriptorstringTexto exibido na fatura do cartão.
trial_period_daysintegerNúmero de dias de trial. O cliente só será cobrado após esse período, quando a assinatura será iniciada.
statusenumStatus do plano. Valores possíveis: active, inactive ou deleted.
shippablebooleanIndica se o produto oferecido pelo plano é passível de entrega. Por exemplo, planos relacionados a serviços não possuem dados para entrega.
created_atdatetimeData de criação do plano.
updated_atdatetimeData de atualização do plano.
deleted_atdatetimeData de exclusão do plano.
itemsarray of objectsItens do plano.Saiba mais sobre itens do plano.
metadataobjectInformações adicionais sobre o plano. Saiba mais sobre metadata.

Exemplos de Requests de criação de plano, com diferentes tipos de precificação:

{
    "name": "Plano somente com Parâmetros Obrigatórios", // Nome do plano
    "payment_methods": [
        "credit_card",
        "boleto",
        "debit_card"
    ], // Meios de pagamentos aceitos. Caso o parâmetro não seja indicado, a assinatura somente poderá ser paga via credit card
    "items": [
        {
            "name": "Nome do item 1",
            "quantity": 1,
            "pricing_scheme": {
                "price": 18990
            }
        }
    ] // Um item pode conter diversos atributos, porém ao gerar um plano somente estes são obrigatórios
}
{
    "name": "Plano Unit", // Nome do plano
    "description": "Plano de teste", // Descrição do plano
    "shippable": "True", // Indica se o plano oferece entrega
    "payment_methods": [
        "credit_card",
        "boleto",
        "debit_card"
    ], // Meios de pagamentos aceitos. Caso o parâmetro não seja indicado, a assinatura somente poderá ser paga via credit_card
    "minimum_price": "1000", // Valor mínimo em centavos da fatura
    "statement_descriptor": "Plano contratado", // Texto exibido na fatura do cartão de crédito. Máximo 13 caracteres
    "currency": "BRL", // Moeda
    "interval": "month", // Frequência da recorrência. Valores possíveis: day,week, month ou year
    "installments": [
        2
    ], // Opções de parcelamento disponíveis. Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista
    "interval_count": 2, // Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura
    "trial_period_days": 10, // Dias de teste
    "billing_type": "prepaid", // Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day
    "items": [
        {
            "name": "Nome do item 1",
            "quantity": 1,
            "status": "active", // Valores possíveis: active, inactive ou deleted
            "pricing_scheme": {
                "scheme_type": "unit",
                "price": 18990
            }
        }
    ]
}
{
    "name": "Plano Package", // Nome do plano
    "description": "Plano de teste", // Descrição do plano
    "shippable": "True", // Indica se o plano oferece entrega
    "payment_methods": [
        "credit_card",
        "boleto",
        "debit_card"
    ], // Meios de pagamentos aceitos. Caso o parâmetro não seja indicado, a assinatura somente poderá ser paga via credit_card
    "minimum_price": "10000", // Valor mínimo em centavos da fatura
    "statement_descriptor": "Plano contratado", // Texto exibido na fatura do cartão de crédito. Máximo 13 caracteres
    "currency": "BRL", // Moeda
    "interval": "month", // Frequência da recorrência. Valores possíveis: day,week, month ou year
    "installments": [
        2
    ], // Opções de parcelamento disponíveis. Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista
    "interval_count": 2, // Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura
    "trial_period_days": 10, // Dias de teste
    "billing_type": "prepaid", // Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day
    "items": [
        {
            "name": "Nome do item 1",
            "quantity": 1,
            "status": "active", // Valores possíveis: active, inactive ou deleted
            "pricing_scheme": {
                "mininum_price": "1000",
                "scheme_type": "package", // Tipo de unidade de precificação. Valores possíveis são: unit, package, volume e tier. Default: unit
                "price_brackets": [
                    {
                        "start_quantity": 0,
                        "end_quantity": 10,
                        "price": 5000
                    },
                    {
                        "start_quantity": 11,
                        "end_quantity": 50,
                        "price": 7000
                    },
                    {
                        "start_quantity": 51,
                        "end_quantity": 100,
                        "price": 10000,
                        "overage_price": 90
                    }
                ] // Este atributo está disponível para os scheme_type : package, volume e tier
            }
        }
    ]
}
{
    "name": "Plano Volume", // Nome do plano
    "description": "Plano de teste", // Descrição do plano
    "shippable": "True", // Indica se o plano oferece entrega
    "payment_methods": [
        "credit_card",
        "boleto",
        "debit_card"
    ], // Meios de pagamentos aceitos. Caso o parâmetro não seja indicado, a assinatura somente poderá ser paga via credit_card
    "minimum_price": "10000", // Valor mínimo em centavos da fatura
    "statement_descriptor": "Plano contratado", // Texto exibido na fatura do cartão de crédito. Máximo 13 caracteres
    "currency": "BRL", // Moeda
    "interval": "month", // Frequência da recorrência. Valores possíveis: day,week, month ou year
    "installments": [
        2
    ], // Opções de parcelamento disponíveis. Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista
    "interval_count": 2, // Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura
    "trial_period_days": 10, // Dias de teste
    "billing_type": "prepaid", // Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day
    "items": [
        {
            "name": "Nome do item 1",
            "quantity": 1,
            "status": "active", // Valores possíveis: active, inactive ou deleted
            "pricing_scheme": {
                "mininum_price": "1000",
                "scheme_type": "volume", // Tipo de unidade de precificação. Valores possíveis são: unit, package, volume e tier. Default: unit
                "price_brackets": [
                    {
                        "start_quantity": 0,
                        "end_quantity": 10,
                        "price": 5000
                    },
                    {
                        "start_quantity": 11,
                        "end_quantity": 50,
                        "price": 7000
                    },
                    {
                        "start_quantity": 51,
                        "end_quantity": 100,
                        "price": 10000,
                        "overage_price": 90
                    }
                ] // Este atributo está disponível para os scheme_type : package, volume e tier
            }
        }
    ]
}
{
    "name": "Plano Tier", // Nome do plano
    "description": "Plano de teste", // Descrição do plano
    "shippable": "True", // Indica se o plano oferece entrega
    "payment_methods": [
        "credit_card",
        "boleto",
        "debit_card"
    ], // Meios de pagamentos aceitos. Caso o parâmetro não seja indicado, a assinatura somente poderá ser paga via credit_card
    "minimum_price": "10000", // Valor mínimo em centavos da fatura
    "statement_descriptor": "Plano contratado", // Texto exibido na fatura do cartão de crédito. Máximo 13 caracteres
    "currency": "BRL", // Moeda
    "interval": "month", // Frequência da recorrência. Valores possíveis: day,week, month ou year
    "installments": [
        2
    ], // Opções de parcelamento disponíveis. Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista
    "interval_count": 2, // Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura
    "trial_period_days": 10, // Dias de teste
    "billing_type": "prepaid", // Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day
    "items": [
        {
            "name": "Nome do item 1",
            "quantity": 1,
            "status": "active", // Valores possíveis: active, inactive ou deleted
            "pricing_scheme": {
                "mininum_price": "1000",
                "scheme_type": "tier", // Tipo de unidade de precificação. Valores possíveis são: unit, package, volume e tier. Default: unit
                "price_brackets": [
                    {
                        "start_quantity": 0,
                        "end_quantity": 10,
                        "price": 5000
                    },
                    {
                        "start_quantity": 11,
                        "end_quantity": 50,
                        "price": 7000
                    },
                    {
                        "start_quantity": 51,
                        "end_quantity": 100,
                        "price": 10000,
                        "overage_price": 90
                    }
                ] // Este atributo está disponível para os scheme_type : package, volume e tier
            }
        }
    ]
}