v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Listar Assinaturas

Retorna uma lista com as assinaturas geradas pela sua conta, ordenadas pela data de criação, da mais nova para a mais antiga. O campo totalItems indica a quantidade de registros retornados nesta página (igual ao tamanho de items ). Para detectar o fim da listagem, compare items.length com limit : se for menor, não há mais páginas.

get/subscriptions

Query parameters

limitinteger

Limita em até 100 o número de registros listados.

startinteger

Quantos registros pular do início da pesquisa, utilizado para paginação

created_at_fromstring date

Registros criados a partir do momento passado no parâmetro

created_at_tostring date

Registros criados até o momento passado no parâmetro

querystring

Texto para pesquisa. Ao utilizar, deve-se usar paginação (limit, start, etc)

updated_sincestring date

Registros atualizados desde o momento passado no parâmetro

updated_until string date

Registros atualizados até o momento passado no parâmetro

customer_idstring

ID do Cliente

status_filterstring

Usado para filtrar as assinaturas pelo status (due, active, suspended)

plan_identifierstring

Identificador único de plano, usado para filtrar assinaturas.

Response

200

totalItemsinteger

Example response

{
  "items": [
    {
      "id": "282BF13F9DBF4D3D8C5D344FEA370F78",
      "plan_identifier": "basicplan",
      "price_cents": 5,
      "currency": "BRL",
      "customer_name": "Nome do cliente",
      "customer_email": "teste@teste.com",
      "cycled_at": "2024-04-29",
      "payable_with": [
        "pix"
      ],
      "ignore_due_email": true,
      "recent_invoices": [
        {
          "id": "011709254C2347ACAFFCB6C80097917E",
          "due_date": "2024-04-29",
          "status": "expired",
          "total": "R$ 10,00",
          "secure_url": "https://checkout.iugu.com/invoices/01170925-4c23-47ac-affc-b6c80097917e-5455"
        }
      ],
      "subitems": [
        {
          "id": "A2CBB12B5A164E60A05AD0A3FE0C26D4",
          "description": "descrição",
          "quantity": 1,
          "price_cents": 1,
          "price": "R$ 0,01",
          "total": "R$ 0,01"
        }
      ],
      "logs": [
        {
          "id": "6D22ABE205B04AEF84A286C22C74EFE9",
          "description": "Error creating invoice",
          "notes": "Errors: Total deve ser maior que 1",
          "subscription_changes": "{}",
          "created_at": "2024-05-14T13:28:16-03:00"
        }
      ],
      "expires_at": "2024-05-14",
      "created_at": "2024-04-29T12:03:57-03:00",
      "updated_at": "2024-05-14T13:28:15-03:00",
      "customer_id": "796B9E7392444DAA971D3F1E0BE83F89",
      "plan_name": "Plano Básico",
      "customer_ref": "José",
      "plan_ref": "Plano Básico",
      "active": true
    }
  ],
  "facets": {
    "due": {
      "_type": "filter",
      "count": 5
    },
    "active": {
      "_type": "filter",
      "count": 4
    },
    "suspended": {
      "_type": "filter",
      "count": 16
    }
  },
  "totalItems": 25
}