Criar Assinatura

post

https://api.iugu.com/v1/subscriptions

Cria uma Assinatura. Para mais informações sobre como criar uma assinatura

Body Params

plan_identifier

string

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

customer_id

string

required

ID do Cliente

expires_at

date

Data de Vencimento da Assinatura (Formato: 'AAAA-MM-DD').
Define a data da primeira cobrança. As cobranças seguintes são calculadas automaticamente a partir dessa data, conforme o intervalo do plano vinculado (ex.: mensal, anual).

splits

array of objects

Regras de divisão (Split Payment) para todas as Faturas geradas por esta Assinatura.

splits

only_on_charge_success

boolean

Apenas Cria a Assinatura se a Cobrança for bem sucedida. Isso só funciona caso o cliente já tenha uma forma de pagamento padrão cadastrada. Não enviar "expires_at".

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

payable_with

array of strings

Método de pagamento que será disponibilizado para as Faturas desta Assinatura (all, credit_card, bank_slip ou pix). 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

automatic_pix

object

Ao utilizar o objeto automatic_pix, o cliente informado no customer_id deve possuir nome e CPF/CNPJ cadastrados, a assinatura não possui o objeto payer. Se necessário, atualize o cadastro pelo endpoint Editar Cliente.

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. Limite de 30 subitems

subitems

custom_variables

array of objects

Variáveis Personalizadas

custom_variables

two_step

boolean

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

suspend_on_invoice_expired

boolean

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.

only_charge_on_due_date

boolean

Somente efetua a cobrança do primeiro ciclo no dia do vencimento. Por padrão, ao criar uma assinatura e a data atual esteja menor que o billing_days da conta ou do plano, será cobrado.

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.

return_url

string

Cliente é redirecionado para essa URL após efetuar o pagamento da Fatura pela página de Fatura da Iugu.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404

422422