Skip to main content
IUGU is a payment processing platform designed for Brazilian businesses. It provides tools for accepting online payments, managing subscriptions, and handling financial transactions securely, helping companies streamline their payment operations and improve cash flow.

Configuring IUGU as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the IUGU option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

Connect using your IUGU API token. See IUGU authentication for where to create the token in your IUGU account. The following configurations are available:
  • API token: The token to authenticate against the Iugu API service. This field is required and stored securely.
    The financial_statement stream requires a live API token; test tokens will return no balance movement.
  • Initial sync date: Starting point for data extraction. Only records created or updated after this date will be synced. This field is required.
Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data, which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data, which is good if, for example, you don’t want to have deleted data in your catalog.
All IUGU streams use updated_at or entry_date as the replication key where applicable, so incremental syncs advance based on last update time. Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.

Fields by stream

Below you’ll find all available data streams from IUGU and their corresponding fields:
Stream for customer profiles, contact data, addresses, and saved payment methods.
Stream for invoices (charges), including payer data, line items, Pix/boleto context, splits, and financial return schedule.
Stream for subscription plan definitions, pricing per currency, features, and billing rules.
Stream for active and historical subscriptions, including plan reference, customer, add-ons, recent invoices, and audit logs.
Account financial statement stream (Extrato Financeiro): every credit and debit on the Iugu balance.

Data Model

The diagram below shows how the main IUGU streams relate. Join keys reflect typical analytics use; plan_identifier on subscriptions matches identifier on plans.

Use Cases for Data Analysis

Examples below assume default table names in the raw layer (iugu_customers, iugu_invoices, iugu_plans, iugu_subscriptions). Adjust schema and table names to match your catalog. Run queries in Explorer.

1. Invoice volume and totals by status

Summarize how much was billed and collected, grouped by invoice status. Business value:
  • Monitor cash position and outstanding receivables
  • Compare paid vs. open or canceled invoices over a period

2. Active subscriptions with customer email

List active subscriptions joined to customers for outreach or churn analysis. Business value:
  • Segment subscribers by plan or contact
  • Join subscription flags to customer master data

Implementation Notes

Amounts and types

  • Monetary amounts are often exposed both as integer cents fields and as formatted strings from the API; prefer _cents columns for aggregations when available.
  • Some invoice timestamp fields exist as plain strings alongside *_iso datetime fields; use the ISO fields when you need reliable temporal filtering.

Incremental sync

  • Streams use updated_at (or entry_date) as the replication key; set Start Date to bound the initial backfill.
  • To prevent hitting the API’s 10,000 records listing limit on high-volume updates, incremental syncs also slide created_at windows automatically.
  • Use Additional Full Sync if you need periodic reconciliation with IUGU’s current state.

Pagination and timeouts

  • Bounded windows: To prevent the IUGU API from timing out (Cloudflare 504/524) when searching through sparse historical data, the connector walks backwards from today to the Start Date using bounded time windows. The window size dynamically adjusts (between 1 and 128 days) based on data density.
  • Automatic throttling: If IUGU responds too slowly, the connector automatically shrinks the page size (from 100 down to 1 record) and halves the time window to bypass the timeout, then scales back up after a few successful clean pages. You may see warnings in your run logs when this happens, and the run may take longer.
  • Timezones: Date filters and bounds in IUGU are day-granular and evaluate in Brasília time (America/Sao_Paulo).

Financial Statement (Extrato Financeiro)

  • Live token required: The financial_statement stream requires a live API token. Test tokens will not return any balance movement.
  • Synthetic IDs: The statement entries do not have a native ID returned by the API. The connector generates a synthetic SHA-256 ID based on the entry’s identifying fields and its position among identical entries on the same day.
  • Timezones and daily syncs: The stream filters only by date, walking one day at a time using the America/Sao_Paulo timezone. Since entries do not have a time of day, hourly runs will re-read the current day and merge entries by their synthetic ID securely.
  • Cent conversions: amount_cents and balance_cents arrive from the API as strings ("100.0") and are automatically cast to integers by the connector.

API and performance

  • Selecting only the streams you need reduces extraction time and API load.
  • Large nested arrays (for example split_rules, items, payment_methods) can make rows wide; consider flattening in a downstream Query or Notebook if you model them as separate tables.
  • Listing limit: The IUGU API caps all list responses at 10,000 records, returning an error for deeper offsets. The connector safely bypasses this across all streams by automatically paginating through short date windows rather than relying on standard offset pagination.

Skills for agents

Download IUGU skills file

IUGU connector documentation as plain markdown, for use in AI agent contexts.