List
Read live records straight from the Orb API.
- Source
- Finance & Ops Analytics
- Alpha
- 4 entities
Move Orb data anywhere it matters.
Send Orb subscriptions, plans and customers to any warehouse, lake or AI app.
Source
Orb
Snowflake
BigQuery
Postgres
Databricks
Claude
- Streams
- 5
- Entities
- 4
- Actions
- 4
- Destinations
- 50+
- Standard support
- 2.1.22
Overview
What is the Airbyte Orb connector?
The Airbyte Orb connector extracts data from Orb and loads it into 50+ destinations such as Snowflake, BigQuery, Databricks or Postgres, with full refresh and incremental sync. It publishes 5 streams you can select per connection.
- 01
Sync to your warehouse
Land 5 Orb tables in 50+ destinations on a schedule you control.
- 02
Context store search
Query synced Orb data with filters, sorting and semantic search, without spending Orb API rate limits.
- 03
Incremental syncs
Pull only the records that changed since the last run instead of reloading everything.
- 04
One authorization
Authenticate Orb once. The same connection powers scheduled syncs and runtime actions.
5 streams
Every table you can sync from Orb
Subscriptions Sync modes FullIncr. Plans Sync modes FullIncr. Customers Sync modes FullIncr. Credits Ledger Entries Sync modes FullIncr. Subscription Usage Sync modes FullIncr.
Setup
Live in seven steps
First, navigate to the Orb source connector page on Airbyte.com.
Click on the "Add Source" button to begin the process of adding your Orb source connector.
Select the Orb source connector from the list of available connectors.
Enter the necessary credentials for your Orb source connector, including the API key and any other required information.
Once you have entered your credentials, click on the "Test" button to ensure that your connection is working properly.
If the test is successful, click on the "Save" button to save your Orb source connector settings.
You can now use your Orb source connector to import data into Airbyte and begin using it for your data integration needs. It is important to note that the specific steps for connecting your Orb source connector may vary depending on your specific use case and the requirements of your data integration project. For more detailed information on how to connect your Orb source connector on Airbyte.com, please refer to the documentation provided on the Airbyte website.
Configuration fields
| Field | Type | Description |
|---|---|---|
| api_key* | string | Orb API Key, issued from the Orb admin console. |
| start_date* | string | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter. |
| end_date | string | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the timeframe_start API parameter. |
| lookback_window_days | integer | When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. |
| numeric_event_properties_keys | array | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. |
| plan_id | string | Orb Plan ID to filter subscriptions that should have usage fetched. |
| string_event_properties_keys | array | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. |
| subscription_usage_grouping_key | string | Property key name to group subscription usage by. |
4 actions
Supported Orb actions
Get
Fetcha single record by ID.Context Store Search
Query synced data with filters and sorting, with no API rate limits.
Semantic Search
Natural-language search across synced Orb records.
Full parameter-level details live in the Orb entity reference.
Hybrid deployment
Sovereign by architecture, not by policy.
The data plane runs in your environment. Records, credentials and keys stay with you; the control plane only receives configuration and job metadata.
- Cloud
- OSS
- Hybrid
Your environment
Airbyte control plane
Use cases
What teams build with Orb
Show me all my customers in Orb
Show me details for a recent customer
List all active subscriptions
What is the status of a recent subscription?
Show me the details of the most recent subscription
What plans are available?
Show me the pricing details for a plan
Show me recent invoices
Confirm the Stripe ID linked to a customer
What is the payment provider ID for a customer?
List all invoices for a specific customer
List all subscriptions for customer XYZ
Show all active subscriptions for a specific customer
What subscriptions does customer external_customer_id have?
Pull all invoices from the last month
Show invoices created after date
List all paid invoices for customer customer_id
What invoices are in draft status?
Show all issued invoices for subscription subscription_id
Related connectors
FAQ
Orb connector questions
Do I need more than one Orb connection?
No. One Orb authorization powers both the scheduled syncs that land data in your destination and the entity actions your agents call at runtime.
Do Orb entity actions need a sync to run first?
No. Entity actions read and write through the Orb API as they are called, so they work immediately. Context store search is the exception: it queries data Airbyte has already synced, which is what lets it filter and sort without spending API rate limits.
What data can I sync from Orb with Airbyte?
5 streams: Subscriptions, Plans, Customers, Credits Ledger Entries, Subscription Usage.
Does the Orb connector support incremental sync?
Yes. The Orb connector supports incremental sync on selected streams, and full refresh on every stream.
Where can I run the Orb connector?
Run the Orb connector on Cloud, OSS, Hybrid. Hybrid deployments keep the data plane in your environment while the control plane orchestrates syncs.
Didn't find your answer? Talk to sales
Start syncing Orb in minutes.
Free 14-day trial. One connection powers your scheduled syncs and your live Orb actions.