Orb
Overview
The Orb source supports Full Refresh and Incremental syncs. Incremental syncs read and output only new records, based on their created_at timestamp.
Output schema
The source syncs the following core resources. Each resource has a separate Stream, and every Stream is incremental:
For an incremental sync, Credits Ledger Entries must read all Customers. However, they return only new ledger entries for each customer.
For an incremental sync, the Subscription Usage stream must read all Subscriptions. It must also read all Plans when using the optional subscription_usage_grouping_key. It returns only new usage entries for each subscription.
Incremental syncs
The Orb API can’t query objects based on an updated_at time. Instead, this connector uses the created_at field to query for new data since the last sync. For the Subscription Usage stream, it uses the timeframe_start field.
Run a periodic Full Refresh to capture data updated after creation.
Features
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Yes |
| Incremental - Dedupe Sync | Yes |
| SSL connection | Yes |
Performance considerations
The Orb connector shouldn’t encounter Orb API limitations during normal use. Please create an issue if any rate limit issues aren’t retried successfully.
:::warning
The credit_ledger_entries stream now includes events data. This upgrade uses the created_at timestamps from the credits to define a 30-day timeframe. The earliest created_at marks the starting point. The Orb API sets this restriction.
:::
:::info
When using the start_date and end_date parameter with the credit_ledger_entries stream, it syncs all customers created within that time window. You can’t query data directly using credit_ledger_entries. The connector must first retrieve customer data before ingesting the credit data.
:::
Getting started
Requirements
- Orb Account
- Orb API Key
Setup guide
Contact the Orb team at [email protected] to request an Orb Account and API Key.
IP allow list
If you use Airbyte Cloud and your organisation restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 2.1.23 | 2026-10-27 | 78910 | Update dependencies |
| 2.1.22 | 2025-05-24 | 60516 | Update dependencies |
| 2.1.21 | 2025-05-10 | 60083 | Update dependencies |
| 2.1.20 | 2025-05-04 | 59524 | Update dependencies |
| 2.1.19 | 2025-04-27 | 59063 | Update dependencies |
| 2.1.18 | 2025-04-19 | 58508 | Update dependencies |
| 2.1.17 | 2025-04-12 | 57888 | Update dependencies |
| 2.1.16 | 2025-04-05 | 57304 | Update dependencies |
| 2.1.15 | 2025-03-29 | 56758 | Update dependencies |
| 2.1.14 | 2025-03-22 | 56230 | Update dependencies |
| 2.1.13 | 2025-03-08 | 55552 | Update dependencies |
| 2.1.12 | 2025-03-01 | 55033 | Update dependencies |
| 2.1.11 | 2025-02-23 | 54564 | Update dependencies |
| 2.1.10 | 2025-02-15 | 54019 | Update dependencies |
| 2.1.9 | 2025-02-08 | 53476 | Update dependencies |
| 2.1.8 | 2025-02-01 | 53005 | Update dependencies |
| 2.1.7 | 2025-01-25 | 52516 | Update dependencies |
| 2.1.6 | 2025-01-18 | 51886 | Update dependencies |
| 2.1.5 | 2025-01-11 | 51350 | Update dependencies |
| 2.1.4 | 2024-12-28 | 50741 | Update dependencies |
| 2.1.3 | 2024-12-21 | 50228 | Update dependencies |
| 2.1.2 | 2024-12-14 | 49693 | Update dependencies |
| 2.1.1 | 2024-12-12 | 48296 | Update dependencies |
| 2.1.0 | 2024-10-23 | 47288 | Migrate to manifest only format |
| 2.0.14 | 2024-10-29 | 46770 | Update dependencies |
| 2.0.13 | 2024-10-05 | 46395 | Update dependencies |
| 2.0.12 | 2024-09-28 | 45785 | Update dependencies |
| 2.0.11 | 2024-09-14 | 45472 | Update dependencies |
| 2.0.10 | 2024-09-07 | 45212 | Update dependencies |
| 2.0.9 | 2024-08-24 | 44626 | Update dependencies |
| 2.0.8 | 2024-08-10 | 43601 | Update dependencies |
| 2.0.7 | 2024-08-03 | 43163 | Update dependencies |
| 2.0.6 | 2024-07-20 | 42198 | Update dependencies |
| 2.0.5 | 2024-07-13 | 41720 | Update dependencies |
| 2.0.4 | 2024-07-10 | 41386 | Update dependencies |
| 2.0.3 | 2024-07-09 | 41090 | Update dependencies |
| 2.0.2 | 2024-07-06 | 40826 | Update dependencies |
| 2.0.1 | 2024-06-29 | 40541 | Update dependencies |
| 2.0.0 | 2024-06-24 | 40227 | Migrate connector to Low Code. Update data type of credit_block_per_unit_cost_basis field in credits_ledger_entries stream to match return type from the upstream API |
| 1.2.4 | 2024-06-22 | 40004 | Update dependencies |
| 1.2.3 | 2024-06-04 | 39015 | [autopull] Upgrade base image to v1.2.1 |
| 1.2.2 | 2024-04-19 | 37211 | Updating to 0.80.0 CDK |
| 1.2.1 | 2024-04-12 | 37211 | schema descriptions |
| 1.2.0 | 2024-03-19 | x | Expose end_dateparameter |
| 1.1.2 | 2024-03-13 | x | Fix window to 30 days for events query timesframe start and query |
| 1.1.1 | 2024-02-07 | 35005 | Pass timeframe_start, timeframe_end to events query |
| 1.1.0 | 2023-03-03 | 24567 | Add Invoices incremental stream merged from #24737 |
| 1.0.0 | 2023-02-02 | 21951 | Add SubscriptionUsage stream, and made start_date a required field |
| 0.1.4 | 2022-10-07 | 17761 | Fix bug with enriching ledger entries with multiple credit blocks |
| 0.1.3 | 2022-08-26 | 16017 | Add credit block id to ledger entries |
| 0.1.2 | 2022-04-20 | 11528 | Add cost basis to ledger entries, update expiration date, sync only committed entries |
| 0.1.1 | 2022-03-03 | 10839 | Support ledger entries with numeric properties + schema fixes |
| 0.1.0 | 2022-02-01 | New Source: Orb | |
| :--- | :--- | :--- | :--- |