v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Editar Subconta

Atualiza os parâmetros de uma conta de pagamentos.<div class="magic-block-callout type-warning"><h3><i title="Danger" class="fa fa-exclamation-triangle"></i> IMPORTANTE!</h3><div class="callout-body"><p>Para executar esta chamada é necessário que a conta esteja <a href="https://dev.iugu.com/reference/enviar-verifica%C3%A7%C3%A3o-de-subconta">verificada</a>. Atenção: Para a Autenticação, no lugar do token de API da conta (api_token), deve-se utilizar o token de usuário (user_token), gerado no retorno da <a href="https://dev.iugu.com/reference/criar-subconta">chamada de criação de subconta</a>.

put/accounts/{id}

Path parameters

idstring required

ID da conta a ser atualizada.

Request body

subscriptions_billing_daysinteger

Número de dias antes do vencimento da assinatura para criação da fatura referente ao próximo ciclo.

subscriptions_trial_periodinteger

Duração (em dias) do período de testes de uma assinatura.

default_return_urlstring

URL padrão para a qual direcionar o cliente após o pagamento de uma fatura via web.

owner_emails_to_notifystring

Lista de emails, separados por vígula, que devem receber notificações específicas para usuários com permissão de "dono".

reply_tostring

E-mail para resposta dos clientes

websitestring required

Deve começar com http:// ou https://. <br>Exemplo: http://www.exemplo.com/</br>

auto_withdraw_typestring

Periodicidade da agenda: daily, weekly, biweekly ou monthly.<br> Quando presente, ativa a agenda. Ausente ou vazio, desativa.

auto_withdraw_optioninteger

Depende do auto_withdraw_type. Para weekly e biweekly: dia da semana de 1 a 5 (1= Segunda, 2= Terça, 3= Quarta, 4= Quinta, 5= Sexta). Para monthly: dia do mês de 1 a 31. Não se aplica a daily.

auto_withdraw_anchor_datestring

Apenas biweekly: data de referência (início do ciclo) que define quais semanas são ativas. (Formato: 'AAAA-MM-DD'). <br> Obrigatória para biweekly; ignorada para os demais tipos.

Response

200

idstring
namestring
created_atstring
updated_atstring
can_receive?boolean
is_verified?boolean
last_verification_request_statusstring
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:last_verification_request_data","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:last_verification_request_feedback","oasType":"schema","type":"unknown"}
change_plan_typeinteger
subscriptions_trial_periodinteger
subscriptions_billing_daysinteger
disable_emailsboolean
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:last_withdraw","oasType":"schema","type":"unknown"}
reply_tostring
webapp_on_test_modeboolean
marketplaceboolean
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:default_return_url","oasType":"schema","type":"unknown"}
credit_card_verifiedboolean
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:fines","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:late_payment_fine","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:per_day_interest","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:old_advancement","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:early_payment_discount","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:early_payment_discount_days","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:early_payment_discount_percent","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:sac_phone","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:sac_email","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:informations","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:configuration","oasType":"schema","type":"unknown"}
auto_withdrawboolean
disabled_withdrawboolean
payment_email_notificationboolean
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:payment_email_notification_receiver","oasType":"schema","type":"unknown"}
auto_advanceboolean
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:auto_advance_type","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:auto_advance_option","oasType":"schema","type":"unknown"}
balancestring
balance_in_proteststring
balance_available_for_withdrawstring
protected_balancestring
customer_minimum_balance_centsinteger
payable_balancestring
receivable_balancestring
commission_balancestring
volume_last_monthstring
volume_this_monthstring
total_subscriptionsinteger
total_active_subscriptionsinteger
taxes_paid_last_monthstring
taxes_paid_this_monthstring
has_bank_address?boolean
permissionsstring[]
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:custom_logo_url","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:custom_logo_small_url","oasType":"schema","type":"unknown"}
early_payment_discountsobject[]
{"stackTrail":"paths:/accounts/{id}:put:responses:200:content:application/json:schema:properties:commissions","oasType":"schema","type":"unknown"}
splitsobject[]

Example response

{
  "id": "0C1FAA736E13411696C3A2E8FF519033",
  "name": "Subconta E",
  "created_at": "2024-08-03T17:07:01-03:00",
  "updated_at": "2024-08-20T11:49:11-03:00",
  "can_receive?": true,
  "is_verified?": true,
  "last_verification_request_status": "accepted",
  "change_plan_type": 1,
  "subscriptions_billing_days": 5,
  "reply_to": "no-reply@iugu.com",
  "credit_card_verified": true,
  "bank_accounts": [
    {
      "branch": "0002",
      "number": "4421692",
      "digit": "0"
    }
  ],
  "balance": "R$ 0,00",
  "balance_in_protest": "R$ 0,00",
  "balance_available_for_withdraw": "R$ 0,00",
  "protected_balance": "R$ 0,00",
  "payable_balance": "R$ 0,00",
  "receivable_balance": "R$ 0,00",
  "commission_balance": "R$ 0,00",
  "volume_last_month": "R$ 0,00",
  "volume_this_month": "R$ 0,00",
  "taxes_paid_last_month": "R$ 0,00",
  "taxes_paid_this_month": "R$ 0,00",
  "has_bank_address?": true,
  "permissions": [
    "owner"
  ],
  "contact_data": {
    "name": "Subconta E",
    "document_number": "11343675030",
    "full_address": "Rua, Bairro, Cidade/SP, 13056344"
  }
}