Skip to content
Book a demoStart free
Connectors

Orb connector

Set up the Orb connector in Kaivo: authentication, configuration, the 6 BigQuery tables it syncs, and answers to common questions.

Orb connector pricing, tier and credits on kaivo.io

Kaivo is a fully managed data platform that syncs your Orb data into a Google BigQuery warehouse and keeps it up to date automatically. There is no pipeline to build and no infrastructure to run, so you can spend your time analysing your payment and finance data instead of moving it.

Sync your Orb usage-based billing data into BigQuery with Kaivo to analyse subscriptions, usage, and revenue.

CategoryFinance & Payments
AuthenticationAPI key
SetupSelf-service
  1. Sign up for Kaivo and create a workspace.
  2. Connect your Orb account.
  3. Choose which tables to sync.
  4. Wait for the initial sync to finish.
  5. Query your data in BigQuery or your favourite AI or BI tool.

Authenticate with your Orb API Key.

Field Description
Orb API Key
Orb API Key, issued from the Orb admin console.

|

When you set up the connector, you provide:

Field Description
Start Date
Any data before this date will not be fetched.

| | Event Properties Keys (String Values) |

Optional. Names of string-valued event properties to extract and attach to the matching ledger entries (for usage enrichment). Leave blank unless you need event metadata in the ledger.

| | Event Properties Keys (Numeric Values) |

Optional. Names of numeric-valued event properties to extract and attach to the matching ledger entries (for usage enrichment). Leave blank unless you need event metadata in the ledger.

| | Subscription Usage Grouping Key |

Optional. Event property key to group Subscription Usage by (one usage series per distinct value).

| | Orb Plan ID |

Optional. Limit Subscription Usage to subscriptions on this Orb Plan ID; leave blank to include all plans.

|

Kaivo syncs 6 tables from Orb into a dedicated dataset in your BigQuery warehouse. Click any table to see its columns and types.

credits_ledger_entries (14 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique ID of the ledger entry
starting_balance FLOAT64 The starting balance before the ledger entry
ending_balance FLOAT64 The ending balance after the ledger entry
amount FLOAT64 The amount of credits involved in the ledger entry
block_expiry_date TIMESTAMP The date and time when the credit block will expire
created_at TIMESTAMP The date and time when the ledger entry was created
entry_type STRING The type of ledger entry (e.g., debit, credit)
new_block_expiry_date TIMESTAMP The new expiry date and time of the credit block after the ledger entry
customer_id STRING The ID of the customer associated with the ledger entry
credit_block_per_unit_cost_basis FLOAT64 The cost per unit of the credit block
description STRING A description of the ledger entry
credit_block_id STRING The ID of the associated credit block
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
customers (22 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the customer.
external_customer_id STRING The ID of the customer in an external system.
name STRING The name of the customer.
email STRING The email address of the customer.
created_at TIMESTAMP The date and time when the customer account was created.
payment_provider STRING The payment provider used by the customer.
payment_provider_id STRING The ID of the customer in the payment provider’s system.
timezone STRING The timezone setting of the customer.
shipping_address__city STRING The city of the shipping address.
shipping_address__country STRING The country of the shipping address.
shipping_address__line1 STRING The first line in the shipping address.
shipping_address__line2 STRING The second line in the shipping address if applicable.
shipping_address__postal_code STRING The postal code of the shipping address.
shipping_address__state STRING The state or region of the shipping address.
billing_address__city STRING The city of the billing address.
billing_address__country STRING The country of the billing address.
billing_address__line1 STRING The first line in the billing address.
billing_address__line2 STRING The second line in the billing address if applicable.
billing_address__postal_code STRING The postal code of the billing address.
billing_address__state STRING The state or region of the billing address.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
invoices (21 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the invoice.
created_at TIMESTAMP The date and time when the invoice was created.
invoice_date TIMESTAMP The date when the invoice was issued.
due_date TIMESTAMP The due date for the payment of the invoice.
invoice_pdf STRING The URL to download the PDF version of the invoice.
subtotal STRING The subtotal amount before applying taxes or discounts.
total STRING The total amount of the invoice including all charges.
amount_due STRING The total amount due on the invoice.
status STRING The current status of the invoice (e.g., pending, paid, voided).
memo STRING Any additional notes or comments associated with the invoice.
issue_failed_at TIMESTAMP The date and time when issuing the invoice failed.
sync_failed_at TIMESTAMP The date and time when syncing the invoice data failed.
payment_failed_at TIMESTAMP The date and time when the payment for the invoice failed.
payment_started_at TIMESTAMP The date and time when the payment process started for the invoice.
voided_at TIMESTAMP The date and time when the invoice was voided.
paid_at TIMESTAMP The date and time when the invoice was paid.
issued_at TIMESTAMP The date and time when the invoice was issued.
hosted_invoice_url STRING The URL to view the hosted invoice online.
subscription__id STRING The unique identifier of the subscription.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
Column Type Description
_kaivo_parent_id STRING Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo.
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the line item.
quantity FLOAT64 The quantity of the item included in the invoice.
amount STRING The amount for the line item.
name STRING The name or description of the line item.
start_date TIMESTAMP The start date of the service period for the line item.
end_date TIMESTAMP The end date of the service period for the line item.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
plans (7 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the plan
created_at TIMESTAMP The timestamp of when the plan was created
description STRING A short description of the plan
name STRING The name of the plan
product__id STRING The unique identifier of the product
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
Column Type Description
_kaivo_parent_id STRING Foreign key referencing _kaivo_id in the parent table. Auto-generated by Kaivo.
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the price option
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
subscription_usage (9 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
quantity FLOAT64 Quantity of the billable metric used during the specified timeframe
timeframe_start TIMESTAMP Start timestamp of the timeframe during which the usage data is captured
timeframe_end TIMESTAMP End timestamp of the timeframe during which the usage data is captured
billable_metric_name STRING Name of the billable metric associated with the subscription usage
billable_metric_id STRING Unique identifier for the billable metric associated with the subscription usage
subscription_id STRING Unique identifier for the subscription the usage data belongs to
grouping_key STRING
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.
subscriptions (10 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
id STRING The unique identifier of the subscription.
created_at TIMESTAMP The date and time when the subscription was created.
customer_id STRING The unique identifier of the customer associated with the subscription.
external_customer_id STRING The external identifier of the customer associated with the subscription.
start_date TIMESTAMP The date and time when the subscription is set to start.
end_date TIMESTAMP The date and time when the subscription is set to end.
plan_id STRING The unique identifier of the subscription plan assigned to the subscription.
status STRING The current status of the subscription.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

After the first load, Kaivo keeps your BigQuery warehouse up to date for you. Where Orb supports it, each sync pulls only new and changed records so it stays fast; otherwise it refreshes the whole table. Every record keeps its original ID, so you won’t get duplicate rows.

How long does the initial sync take for Orb?

Section titled “How long does the initial sync take for Orb?”

It depends on how much history is in your Orb account. Most initial syncs finish within minutes, while large accounts can take a few hours. After that, syncs only fetch new and changed records, so they’re much faster.

Yes. You pick which tables to sync when you set up the connection and can change the selection later. Tables you don’t select are never copied to your warehouse.

New fields are never added automatically. You choose which fields to sync, so data you haven’t selected (sensitive personal data, for example) never lands in your warehouse. When a new field appears, it becomes available for you to add. What happens to removed or renamed fields depends on a table’s sync mode: full-refresh tables always match what’s currently in Orb, so dropped fields disappear, while incremental tables keep their existing columns and history, so an old field stays and newly added fields fill in over time.

How do I handle GDPR or data deletion requests?

Section titled “How do I handle GDPR or data deletion requests?”

Your data lives in your own Kaivo-managed BigQuery warehouse, so the most direct option is to delete or anonymise specific records right in BigQuery. If you delete data in Orb instead, full-refresh tables drop it on the next sync, while incremental tables keep it, so you would remove the row in BigQuery or ask us to run a full refresh. To remove everything, delete the Orb connector in Kaivo and all of its synced data is deleted with it.

Use subscriptions and invoices to track recurring revenue and churn over time.

Join subscription_usage with credits_ledger_entries to analyse usage-based charges.

Use customers and plans to measure lifetime value and plan mix.

Once Orb data lands in your Kaivo-managed BigQuery warehouse, you can explore it with AI tools or any BI tool that connects to BigQuery. Here’s how the most common destinations work with Orb data.

Use Kaivo’s MCP server to give Claude secure, workspace-scoped access to your data. Setup guide →

Microsoft’s BI tool with a native BigQuery connector. Supports direct query and scheduled refresh. Setup guide →

Free Google BI tool with native BigQuery support. One-click connection to your Kaivo warehouse; great for SMB teams on Google Workspace. Setup guide →

The premium analytics standard, with native BigQuery integration. Setup guide →

Use Connected Sheets to query BigQuery directly from a spreadsheet, with no SQL. Setup guide →

Connect via Power Query’s BigQuery connector. Setup guide →

Open-source BI tool with strong BigQuery support. Setup guide →

See our pricing page for Orb connector pricing and plan details.