--- title: "Listar Assinaturas" method: GET path: "/v1/customer_subscriptions" tags: ["Assinaturas"] --- # Listar Assinaturas `GET /v1/customer_subscriptions` Lista assinaturas. ## Query parameters - `customer_person_name` string - `customer_cnpj_cpf` string - `customer_email` string - `page` integer - `per_page` integer ## Headers - `User-Agent` string - `X-Idempotency-Key` string ## Response `200` Sucesso na listagem de assinaturas - CustomerSubscriptionObject[] - `id` integer — ID da assinatura - `customer_id` integer, nullable — ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios. - `customer_person_name` string, required — Nome do cliente - `customer_nickname` string, nullable — Apelido ou Nome Fantasia do Pagador - `customer_cnpj_cpf` string, required — CPF/CNPJ do cliente - `customer_zipcode` string, required — CEP (formato 99999999) - `customer_email` string, email, nullable — E-mail do Pagador - `customer_email_cc` string, email, nullable — E-mail alternativo do Pagador - `customer_address` string, required — Endereço - `customer_city_name` string, required — Cidade(Nome deve estar correto e completo) - `customer_state` string, required — Estado - `customer_neighborhood` string, required — Bairro - `customer_address_number` string — Número - `customer_address_complement` string, nullable — Complemento - `customer_phone_number` string, nullable — Telefone (com DDD, DDI é opcional) - `customer_person_type` 'individual' | 'juridical', nullable — Tipo de Pagador. * `individual` Pessoa Física * `juridical` Pessoa Jurídica - `customer_mobile_local_code` string, nullable — DDD do Celular - `customer_mobile_number` string, nullable — Celular - `customer_notes` string, nullable — Observações do Pagador - `customer_ignore_email` boolean, nullable — Nunca enviar e-mail para este cliente - `customer_ignore_sms` boolean, nullable — Nunca enviar SMS para este cliente - `customer_contact_person` string, nullable — Contato - `customer_update` string, nullable — Contato - `bank_billet_account_id` integer, required — ID da Carteira de Cobrança. Se não informado, usará a carteira padrão. - `amount` number, float, required — Valor da Assinatura (R$) - `cycle` 'biweekly' | 'bimonthly' | 'monthly' | 'quarterly' | 'semiannual' | 'annual', nullable — Ciclo da assinatura. Default: monthly * `biweekly` Quinzenal * `bimonthly` Bimestral * `monthly` Mensal * `quarterly` Trimestral * `semiannual` Semestral * `annual` Anual - `next_billing` string, date — Data da Primeira ou Próxima cobrança. Caso não seja enviado uma data, esse campo será calculado para ter o valor do dia da criação da assinatura mais o ciclo escolhido. Ex.: Mensal(Hoje + 30 dias) - `end_at` string, date, nullable — Data em que deseja parar as cobranças. Caso em branco, as cobranças serão geradas automaticamente até que se informe uma data ou se exclua a assinatura. - `description` string, nullable — Descrição do produto ou serviço - `instructions` string, nullable — Instruções para o Caixa - `days_in_advance` integer — Com quantos dias de antecedência à data de vencimento a cobrança será gerada. Default: 7. - `fine_type` 0 | 1 | 2, nullable — Tipo de multa: * `0` Inexistente (Padrão) * `1` Para percentual do valor do boleto * `2` Para valor fixo - `days_for_fine` integer, nullable — Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento). - `fine_percentage` number, float, nullable — Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1 - `fine_value` number, float, nullable — Valor da multa (R$). Obrigatório se fine_type é igual a 2. - `interest_type` 0 | 1 | 2, nullable — Tipo de juros/mora: * `0` Inexistente (Padrão) * `1` Para porcentagem diária * `2` Para valor diário - `days_for_interest` integer, nullable — Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento). - `interest_percentage` number, float, nullable — Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1. - `interest_value` number, float, nullable — Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. - `discount_type` 0 | 1 | 2, nullable — Tipo de desconto: O tipo de desconto será o mesmo para todos os três descontos, caso existam. : * `0` Inexistente (Padrão) * `1` Para valor fixo * `2` Para percentual do valor do boleto - `days_for_discount` integer, nullable — Dias para desconto. Obrigatório se discount_type é diferente de 0(zero) - `discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2 - `discount_value` number, float, nullable — Valor do desconto (R$). Obrigatório se discount_type é igual a 1. - `days_for_second_discount` integer, nullable — Dias para segundo desconto. - `second_discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao segundo desconto. - `second_discount_value` number, float, nullable — Valor do segundo desconto (R$). - `days_for_third_discount` integer, nullable — Dias para terceiro desconto. - `third_discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao terceiro desconto. - `third_discount_value` number, float, nullable — Valor do terceiro desconto (R$). - `bank_billet_layout_id` integer, nullable — ID do Modelo de Boleto - `notes` string, nullable — Observações - `tags` string[], nullable — Tags associadas ao boleto - `bank_billet_ids` integer[], nullable — IDs de boletos vinculados ao carnê - `prevent_registration` boolean, nullable — Impedir envio de registro ao banco: Caso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema. - `divergent_payment_type` null | 1 | 2 | 3 | 4, nullable — Tipo de pagamento divergente: Válido apenas para Itaú e Caixa. * `1` Aceita qualquer valor divergente * `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais * `3` Não aceita pagamento de valores divergentes * `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo - `divergent_payment_value_type` null | 1 | 2, nullable — Tipo de valor a considerar para os limites de pagamentos: Válido apenas para Itaú e Caixa. * `1` Informa pagamentos divergentes por valores * `2` Informa pagamentos divergentes por percentuais - `divergent_payment_maximum_value` number, float, nullable — Valor máximo para a faixa de pagamentos divergentes. - `divergent_payment_minimum_value` number, float, nullable — Valor mínimo para a faixa de pagamentos divergentes. - `divergent_payment_maximum_percentage` number, float, nullable — Percentual máximo para a faixa de pagamentos divergentes. - `divergent_payment_minimum_percentage` number, float, nullable — Percentual mínimo para a faixa de pagamentos divergentes. - `divergent_payment_limit` integer, nullable — Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa. - `custom_attachment_name` string, nullable — Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID. - `guarantor_name` string, nullable — Nome do Beneficiário final (Sacador/Avalista) - `guarantor_cnpj_cpf` string, nullable — CNPJ/CPF do Beneficiário final (Sacador/Avalista) - `guarantor_address_number` string, nullable — Número do Beneficiário final (Sacador/Avalista) - `guarantor_neighborhood` string, nullable — Bairro do Beneficiário final (Sacador/Avalista) - `guarantor_phone_number` string, nullable — Telefone (com DDD) do Beneficiário final (Sacador/Avalista) - `guarantor_city_name` string, nullable — Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista) - `guarantor_state` string, nullable — Estado do Beneficiário final (Sacador/Avalista) - `guarantor_zipcode` string, nullable — CEP (formato 99999999) do Beneficiário final (Sacador/Avalista) - `guarantor_address` string, nullable — Endereço do Beneficiário final (Sacador/Avalista) - `guarantor_address_complement` string, nullable — Complemento do Beneficiário final (Sacador/Avalista) - `days_for_revoke` integer, nullable — Dias corridos para Baixa/Devolução: Nulo/Branco: Obedece ao padrão do banco. 0: Baixa/Devolução no mesmo dia do vencimento. 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos). - `days_for_negativation` integer, nullable — Dias corridos para Negativação: Disponível apenas para os seguintes bancos e formatos. * Banco | CNAB 240| CNAB 400 |Webservice * Bradesco | Sim | Sim | Não * Itaú | Não | Sim | Não - `days_for_sue` integer, nullable — Dias corridos para Protesto - `payment_count` integer, nullable — Quantidade de pagamentos parciais aceitos para este boleto. - `import_id` integer, nullable — ID da Importação - `ignore_whatsapp` boolean, nullable — Nunca enviar esta asinatura por WhatsApp - `created_at` string, date-time, nullable — Data e hora de criação do registro - `updated_at` string, date-time, nullable — Data e hora da última atualização do registro ## Other responses - `401` — Falha de autenticação. Token inválido - `403` — Falha de permissão. Você não tem o Scope obrigatório para essa chamada. --- [API](https://skmtc.net/kobana/apis/cobran-as.md) · [All operations](https://skmtc.net/kobana/apis/cobran-as/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kobana/cobran-as/versions/728c362ec4d7/schema)