Editar Assinatura

put

https://api.iugu.com/v1/subscriptions/{id}

Altera os dados de uma Assinatura, quaisquer parâmetros não informados não serão alterados.

Path Params

string

required

ID da Assinatura

Body Params

plan_identifier

string

Identificador do Plano. Só é enviado para assinaturas que não são credits_based

expires_at

date

Data de Expiração "AAAA-MM-DD". (Também é a data da próxima cobrança)

payable_with

array of strings

Método de pagamento que será disponibilizado para as Faturas desta Assinatura (all, credit_card, pix ou bank_slip). Obs: Dependendo do valor, este atributo será herdado, pois a prioridade é herdar o valor atribuído ao Plano desta Assinatura; caso este esteja atribuído o valor ‘all’, o sistema considerará o payable_with da Assinatura; se não, o sistema considerará o payable_with do Plano

payable_with

ignore_due_email

boolean

Desabilita o envio de emails notificando o vencimento de uma fatura em assinaturas que podem ser pagas com boleto bancário.

credits_based

boolean

É uma assinatura baseada em créditos? booleano

price_cents

int32

Preço em centavos da recarga para assinaturas baseadas em crédito

credits_cycle

int32

Quantidade de créditos adicionados a cada ciclo, só enviado para assinaturas credits_based

credits_min

int32

Quantidade de créditos que ativa o ciclo, por ex: Efetuar cobrança cada vez que a assinatura tenha apenas 1 crédito sobrando. Esse 1 crédito é o credits_min

subitems

array of objects

Adiciona itens de cobrança a mais na assinatura do cliente. "price_cents" valor mínimo 100. Para remover, envie "id" do subitem + "_destroy:true"

subitems

suspended

boolean

Assinatura suspensa? booleano

skip_charge

boolean

Ignorar Cobrança? booleano

custom_variables

array of objects

Variáveis Personalizadas

custom_variables

two_step

boolean

Defaults to false

Habilita/Desabilita transações em duas etapas para a assinatura (precisa ter o da conta ativado para usar)

suspend_on_invoice_expired

boolean

Defaults to true

Quando uma assinatura tem uma fatura expirada, se esse campo estiver como FALSE, assinatura não será suspensa. (porém é necessário ajustar a data de vencimento para seguir com o ciclo.

soft_descriptor_light

string

Altera a descrição da cobrança no cartão de crédito do cliente final (Até 12 caracteres). Caso não seja enviado, será utilizada a descrição configurada na conta.

Responses

200200

400400