v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Editar Assinatura

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

put/subscriptions/{id}

Path parameters

idstring required

ID da Assinatura

Request body

plan_identifierstring

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

expires_atstring date

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

payable_withstring[]

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

ignore_due_emailboolean

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

credits_basedboolean

É uma assinatura baseada em créditos? booleano

price_centsinteger

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

credits_cycleinteger

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

credits_mininteger

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

suspendedboolean

Assinatura suspensa? booleano

skip_chargeboolean

Ignorar Cobrança? booleano

two_stepboolean

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

suspend_on_invoice_expiredboolean

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_lightstring

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.

Response

200

idstring

suspendedboolean

plan_identifierstring

price_centsinteger

currencystring

featuresobject

customer_namestring

customer_emailstring

cycled_atstring

credits_mininteger

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:credits_cycle","oasType":"schema","type":"unknown"}

payable_withstring

ignore_due_emailboolean

max_cyclesinteger

cycles_countinteger

custom_variablesobject[]

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:expires_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

customer_idstring

plan_namestring

customer_refstring

plan_refstring

activeboolean

two_stepboolean

suspend_on_invoice_expiredboolean

{"stackTrail":"paths:/subscriptions/{id}:put:responses:200:content:application/json:schema:properties:in_trial","oasType":"schema","type":"unknown"}

creditsinteger

credits_basedboolean

Example response

{
  "id": "B3F2FE4AA10A433ABB5A1B11C5882C00",
  "plan_identifier": "plano_teste2",
  "price_cents": 290,
  "currency": "BRL",
  "customer_name": "Teste Name",
  "customer_email": "teste@teste.com",
  "cycled_at": "2024-05-13",
  "payable_with": "credit_card",
  "recent_invoices": [
    {
      "id": "F729BD0749C34AD4AC1581D64262E170",
      "due_date": "2024-05-13",
      "status": "paid",
      "total": "R$ 1,24",
      "secure_url": "https://checkout.iugu.com/invoices/f729bd07-49c3-4ad4-ac15-81d64262e170-d266"
    }
  ],
  "subitems": [
    {
      "id": "1A9183F64A3F40B29A1DCB96116FDF2E",
      "description": "Descrição",
      "quantity": 1,
      "price_cents": 100,
      "price": "R$ 1,00",
      "total": "R$ 1,00"
    }
  ],
  "logs": [
    {
      "id": "27A515BB23764259B545648F06C2BD98",
      "description": "Fatura criada",
      "notes": "Fatura criada com os items:  1x Mudança de Plano: Plano Teste = R$ 1,24;",
      "subscription_changes": "{\"expires_at\":[\"2024-05-14\",null],\"plan_identifier\":[\"provinha\",\"plano_teste2\"],\"price_cents\":[5,290],\"invoice_max_installments\":[6,null],\"updated_at\":[\"2024-05-13T15:37:50-03:00\",\"2024-05-13T15:37:50-03:00\"]}",
      "created_at": "2024-05-13T15:37:51-03:00"
    }
  ],
  "created_at": "2024-03-08T16:35:09-03:00",
  "updated_at": "2024-05-13T15:37:51-03:00",
  "customer_id": "6C2F076EAE524A15A749FEA422D9AF50",
  "plan_name": "Plano Teste",
  "customer_ref": "Bruna Lopes",
  "plan_ref": "Plano Teste",
  "active": true,
  "suspend_on_invoice_expired": true
}