v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Criar Assinatura

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

post/subscriptions

Request body

plan_identifierstring

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

customer_idstring required

ID do Cliente

expires_atstring date

Data de Expiração "YYYY-MM-DD HH:MM:SS +TIMEZONE". (Data da primeira cobrança, as próximas datas de cobrança dependem do "intervalo" do plano vinculado).

only_on_charge_successboolean

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_emailboolean

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

payable_withstring[]

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

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

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.

only_charge_on_due_dateboolean

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_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.

return_urlstring

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

Response

200

idstring

suspendedboolean

plan_identifierstring

price_centsinteger

currencystring

featuresobject

customer_namestring

customer_emailstring

cycled_atstring

credits_mininteger

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

payable_withstring[]

{"stackTrail":"paths:/subscriptions:post:responses:200:content:application/json:schema:properties:ignore_due_email","oasType":"schema","type":"unknown"}

max_cyclesinteger

cycles_countinteger

subitemsobject[]

custom_variablesobject[]

{"stackTrail":"paths:/subscriptions:post: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:post:responses:200:content:application/json:schema:properties:in_trial","oasType":"schema","type":"unknown"}

creditsinteger

credits_basedboolean

Example response

{
  "id": "282BF13F9DBF4D3D8C5D344FEA370F78",
  "plan_identifier": "basicplan",
  "price_cents": 1000,
  "currency": "BRL",
  "customer_name": "José",
  "customer_email": "jose_silva@teste.com",
  "cycled_at": "2024-04-29",
  "payable_with": [
    "credit_card"
  ],
  "recent_invoices": [
    {
      "id": "011709254C2347ACAFFCB6C80097917E",
      "due_date": "2024-04-29",
      "status": "pending",
      "total": "R$ 10,00",
      "secure_url": "https://checkout.iugu.com/invoices/01170925-4c23-47ac-affc-b6c80097917e-5455"
    }
  ],
  "logs": [
    {
      "id": "F56499BE161746078628C13601437A0A",
      "description": "Fatura criada",
      "notes": "Fatura criada com os items:  1x Ativação de Assinatura: Plano Básico = R$ 10,00;",
      "subscription_changes": "{\"plan_identifier\":[null,\"basicplan\"],\"customer_id\":[null,\"796B9E7392444DAA971D3F1E0BE83F89\"],\"price_cents\":[0,1000],\"interval\":[null,1],\"interval_type\":[null,\"months\"],\"payable_with\":[null,\"credit_card,bank_slip,pix\"],\"created_at\":[null,\"2024-04-29T12:03:57-03:00\"],\"updated_at\":[null,\"2024-04-29T12:03:57-03:00\"],\"id\":[null,\"282BF13F9DBF4D3D8C5D344FEA370F78\"]}",
      "created_at": "2024-04-29T12:04:00-03:00"
    }
  ],
  "created_at": "2024-04-29T12:03:57-03:00",
  "updated_at": "2024-04-29T12:04:00-03:00",
  "customer_id": "796B9E7392444DAA971D3F1E0BE83F89",
  "plan_name": "Plano Básico",
  "customer_ref": "José",
  "plan_ref": "Plano Básico",
  "active": true,
  "two_step": true,
  "suspend_on_invoice_expired": true
}