Pular para o conteúdo principal

Atualizar plano existente​

Atualiza um plano existente com base no ID fornecido. Nota: É necessário fornecer o ID do plano que deseja atualizar.

Request Body required

Descreve os dados a serem incluídos no corpo da requisição.

    name string required

    O nome do plano.

    methods PaymentMethods[] required

    Possible values: [credit, billet, pix]

    Os métodos de pagamento que serão aceitos neste plano.

    value number required

    O valor do plano em centavos.

    status PlanStatus

    Possible values: [active, inactive]

    O status do plano.

    interval number required

    O intervalo, ou seja, a periodicidade de cobrança do plano. Por exemplo, para cobrar a cada mês o intervalo é 1.

    interval_type PlanIntervals required

    Possible values: [days, months, years]

    O tipo de ciclo que será usado na contagem dos intervalos. Podendo ser dias, meses ou anos. Por exemplo, para cobrar mensalmente defina interval como 1 e interval_type como months

    dunning_id number required

    Essa configuração se refere a régua de cobrança que será usada para enviar comunicações sobre as assinaturas criadas com este plano. Para testes utilize o valor 1 (régua padrão)

Responses

Plano atualizado com sucesso

Schema
    id string

    O ID do plano.

    uuid string

    O UUID do plano.

    name string

    O nome do plano.

    public_name string

    O nome público do plano.

    methods array

    Os métodos de pagamento do plano.

    value number

    O valor do plano.

    fine number

    A multa do plano.

    interest number

    O juros do plano.

    interval number

    O intervalo do plano.

    interval_type string

    O tipo de intervalo do plano.

    charges number

    As cobranças do plano.

    trial_days number

    Os dias de teste do plano.

    retry_days number

    Os dias de tentativa do plano.

    automatic_cancel boolean

    O cancelamento automático do plano.

    url string

    A URL do plano.

    custom_layout_enabled boolean

    A habilitação do layout personalizado do plano.

    custom_layout string

    O layout personalizado do plano.

    redirect_uri string

    A URI de redirecionamento do plano.

    status string

    O status do plano.

    custom_fields array

    Os campos personalizados do plano.

    billing_products array

    Os produtos de cobrança do plano.

    company object

    A empresa do plano.

    charge_enabled boolean

    A habilitação da cobrança do plano.

    billing_settings object

    As configurações de cobrança do plano.

    dunning object

    O dunning do plano.

    created_at date-time

    A data e hora em que o plano foi criado.

    updated_at date-time

    A data e hora em que o plano foi atualizado.

Loading...