Planos

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

Atributos	Tipo	Descrição
`id`	string	Código do plano. Formato: `plan_XXXXXXXXXXXXXXXX`.
`name`	string	Nome do plano.
`description`	string	Descrição do plano.
`currency`	enum	Moeda. Valores possíveis: `BRL`.
`interval`	enum	Frequência da recorrência. Valores possíveis: `day`,`week`, `month` ou `year`.
`interval_count`	integer	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).
`minimum_price`	integer	Valor mínimo em centavos da assinatura.
`billing_type`	enum	Tipo de cobrança. Valores possíveis: `prepaid`, `postpaid` ou `exact_day`.
`billing_days`	array of integers	Dias disponíveis para cobrança das assinaturas criadas a partir do plano.
`payment_methods`	array of strings	Meios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: `credit_card`, `boleto` ou `cash`.
`installments`	array of integers	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`.
`statement_descriptor`	string	Texto exibido na fatura do cartão.
`trial_period_days`	integer	Número de dias de trial. O cliente só será cobrado após esse período, quando a assinatura será iniciada.
`status`	enum	Status do plano. Valores possíveis: `active`, `inactive` ou `deleted`.
`shippable`	boolean	Indica se o produto oferecido pelo plano é passível de entrega. Por exemplo, planos relacionados a serviços não possuem dados para entrega.
`created_at`	datetime	Data de criação do plano (UTC).
`updated_at`	datetime	Data de atualização do plano (UTC).
`deleted_at`	datetime	Data de exclusão do plano (UTC).
`items`	array of objects	Itens do plano.Saiba mais sobre itens do plano.
`metadata`	object	Informaçõ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
            }
        }
    ]
}