Skip to main content

Orb

Overview

The Orb source supports both Full Refresh and Incremental syncs. For incremental syncs, this source will only read and output new records based on their created_at timestamp.

Output schema

This Source is capable of syncing the following core resources, each of which has a separate Stream. Note that all of the streams are incremental:

As a caveat, the Credits Ledger Entries must read all Customers for an incremental sync, but will only incrementally return new ledger entries for each customers.

Similarily, the Subscription Usage stream must read all Subscriptions for an incremental sync (and all Plans if using the optional subscription_usage_grouping_key), but will only incrementally return new usage entries for each subscription.

Note on Incremental Syncs

The Orb API does not allow querying objects based on an updated_at time. Therefore, this connector uses the created_at field (or the timeframe_start field in the Subscription Usage stream) to query for new data since the last sync.

In order to capture data that has been updated after creation, please run a periodic Full Refresh.

Features

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
Incremental - Dedupe SyncYes
SSL connectionYes

Performance considerations

The Orb connector should not run into Orb API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

warning

The credit_ledger_entries stream will now include events data. This upgrade uses the created_at timestamps from the credits to establish a 30-day timeframe, with the earliest created_at as the starting point. This restriction is set by the Orb API.

info

If you are using the start_date and end_date parameter with the credit_ledger_entries stream it will sync all customers created during the that time window. It isn't possible to query data directly to credit_ledger_entries. The connector need to retrieve data from customers first to ingest the credit data.

Getting started

Requirements

  • Orb Account
  • Orb API Key

Setup guide

Please reach out to the Orb team at [email protected] to request an Orb Account and API Key.

Reference

Config fields reference

Field
Type
Property name
string
api_key
string
start_date
string
end_date
integer
lookback_window_days
array<string>
string_event_properties_keys
array<string>
numeric_event_properties_keys
string
subscription_usage_grouping_key
string
plan_id

Changelog

Expand to review
VersionDatePull RequestSubject
2.0.02024-06-2440227Migrate 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.42024-06-2240004Update dependencies
1.2.32024-06-0439015[autopull] Upgrade base image to v1.2.1
1.2.22024-04-1937211Updating to 0.80.0 CDK
1.2.12024-04-1237211schema descriptions
1.2.02024-03-19xExpose end_dateparameter
1.1.22024-03-13xFix window to 30 days for events query timesframe start and query
1.1.12024-02-0735005Pass timeframe_start, timeframe_end to events query
1.1.02023-03-0324567Add Invoices incremental stream merged from #24737
1.0.02023-02-0221951Add SubscriptionUsage stream, and made start_date a required field
0.1.42022-10-0717761Fix bug with enriching ledger entries with multiple credit blocks
0.1.32022-08-2616017Add credit block id to ledger entries
0.1.22022-04-2011528Add cost basis to ledger entries, update expiration date, sync only committed entries
0.1.12022-03-0310839Support ledger entries with numeric properties + schema fixes
0.1.02022-02-01New Source: Orb
:---:---:---:---