Exported resource types

Resources

The table below provides an overview of the supported resource types, their schema, and any notes on their sync behavior:

Resource Type	Sync Cadence	Notes
Accounting Period Lock	Daily	Accounting Period Lock
Adjustment	Daily	Adjustments
Adjustment Interval	Daily	Adjustments
Billable Metric	Daily	Metric
Commitment	Daily	Represents a customer’s spend commitment on a subscription. See commitment management.
Commitment Ledger Entry Event	Daily	Tracks drawdown activity against a Commitment as separate created and reverted events.
Coupon	Daily	Coupons
Coupon Redemption	Daily	How to use Coupons
Credit Ledger Entry	Daily	Orb syncs all committed (i.e. non-pending) ledger entries.
Credit Ledger Entry Event	Daily	This resource represents the same data as Credit Ledger Entry, but includes additional fields to enable recognition with respect to accounting period locks.
Credit Note	Daily	Credit notes
Credit Note Line Item	Daily
Credit Note Line Item Event	Daily	This resource represents the same data as Credit Note Line Item, but includes additional fields to enable recognition with respect to accounting period locks.
Customer	Daily	Customer
Customer Balance Transaction	Daily
Daily Credit Note Line Item Event	Daily	This resource represents the same data as Credit Note Line Item, but includes additional fields to enable recognition with respect to accounting period locks.
Daily Line Item Revenue	Daily
Daily Line Item Revenue Event	Daily	This resource represents the same data as Daily Line Item Revenue, but includes additional fields to enable recognition with respect to accounting period locks.
Dimensional Price Group	Daily	Dimensional pricing
Invoice Line Item Billing	Daily
Invoice Line Item Billing Event	Daily	This resource represents the same data as Invoice Line Item Billing, but includes additional fields to enable recognition with respect to accounting period locks.
Invoice Metadata	Daily
Item	Daily	Item
License	Daily	License allocations
License Type	Daily	License allocations
Payment Application	Daily	Payments
Payment Attempt	Daily	Payments
Plan	Daily	Plan and Price
Price	Daily	Plan and Price
Price Interval	Daily	Plan and Price
Subscription	Daily	Subscription. The response mirrors the shape of the fetch subscription endpoint. This resource excludes adjustment intervals; see the Adjustment Interval and the Adjustment export resources.
Subscription version	Daily	This captures the subscription schedule of a subscription, specifically allowing you to understand plan transitions.

General guidance

API-based resources

A subset of Orb’s exported resources are based off of the API response shape. These are not directly defined below, but linked to the relevant API reference documentation, and may change as the API evolves. In addition, these resources often include JSON fields that require further parsing and are less well defined.

List of resources

The following resource schemas are dependent on the API resources:

Customer, Plan, and Subscription resources will always have deletion markers in addition to the API response shape.

Nested resources

API-based resources often contain nested fields that reference other objects. For example, the Plan resource references Prices which are a separate, top-level resource. Additionally, API‑based resources often include nested or “helper” fields that duplicate parts of other objects for convenience. These embedded fields are intended to make simple questions easier to answer in a single query and to keep exports readable without many joins.

“Helper fields” are snapshots taken when the top‑level resource was last updated, and may not reflect subsequent changes to the nested objects.For an up‑to‑date or authoritative view, you should always join against the dedicated export for that object.

Dedicated resource recommendations to optimize for freshness of common helper fields:

Snapshot helper fields	Recommended join for dedicated alternative
Subscription `current_billing_period_start_date` `current_billing_period_end_date`	Invoice Metadata Join on `subscription_id`, where `invoice_type` = subscription. Treat `invoice_date` plus plan/price cadence as the billed period.
Subscription `current_billing_period_start_date` `current_billing_period_end_date`	Daily Line item Revenue Group by `subscription_id` and `invoice_id.` Use`timeframe_start, timeframe_end` as period boundaries.
Plan `prices`	Price Join on `price_id`

Resource schemas

Accounting Period Lock

Overview

The accounting period lock resource represents the history of the lock postures of monthly accounting periods in Orb. By default, accounting period entries are initialized in Orb as open, and can be closed by a user. Orb only generates entries for accounting periods when closing open periods or opening closed periods.

If no entries exist for any accounting periods, this means that all periods are currently open.
If only one closed accounting period exists, this means that all periods before that closed period are also closed, and all periods after it are open.

If a closed accounting period is reopened, a new open entry for that period will be generated with the sequence_number incremented. Importantly, a single entry for an accounting period only describes the lock posture of that period at a certain time. To determine the timeline of actions performed on an accounting period, reference all entries for that period in order of ascending sequence_number. To determine the current state of an accounting period, reference the entry for that period with the largest sequence_number.

Schema

Field Name	Type	Description
id	string	The ID of the accounting period lock.
updated_at	timestamp	The last updated date of the accounting period lock.
created_at	nullable timestamp	The timestamp when the accounting period lock was created.
period_start	timestamp	The start timestamp (inclusive) of the period in the account’s timezone. This timestamp is used to determine when revenue events should be recognized.
period_end	timestamp	The end timestamp (exclusive) of the period in the account’s timezone. This timestamp is used to determine when revenue events should be recognized.
conceptual_period_start_date	date	The start timestamp (inclusive) of the period, at midnight UTC time. This timestamp is used to refer to accounting periods consistently.
conceptual_period_end_date	date	The end timestamp (exclusive) of the period, at midnight UTC time. This timestamp is used to refer to accounting periods consistently.
locked_at	nullable timestamp	The timestamp that the period was closed.
unlocked_at	timestamp	The timestamp that the period was opened.
locked_by_user_email	nullable string	The email of the user who closed the period. Note that if the user was deleted before the resource was exported, this email may also be null.
unlocked_by_user_email	nullable string	The email of the user who opened the period. If null, this means that this period was opened by Orb as part of initializing a period. Note that if the user was deleted before the resource was exported, this email may also be null.
sequence_number	int	A key used to order accounting period lock entries in chronological order.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Adjustment

Overview

The adjustment resource represents a minimum, maximum, or discount that can be applied to a single price or a set of prices. See the Adjustments section for more information. The adjustment table is most useful when joining with other tables using the adjustment_id field. For example,

you can see how a coupon is defined by the adjustment_id linked on the coupon resource
you can better understand how an adjustment is applied onto a daily line item revenue resource by inspecting the adjustment_ids column in the Daily Line Item Revenue resource

Schema

Field Name	Type	Description
id	string	The ID of the adjustment.
updated_at	timestamp	The last updated date of the adjustment.
created_at	nullable timestamp	The timestamp when the adjustment was created.
applies_to_price_ids	string[]	The IDs of the prices that the adjustment applies to.
filters	nullable JSON	The set of filters used to scope which prices the adjustment applies to, beyond `applies_to_price_ids`.
adjustment_type	string	The type of adjustment. Can be “minimum”, “maximum”, “percentage_discount”, “amount_discount”, or “usage_discount”.
adjustment_value	decimal	The value of the adjustment. For percentage discounts, this is a percentage. For amount discounts, maximums, and minimums, this is an amount in the price’s currency. For usage discounts, this is a percentage.
currency	string	The currency of the adjustment. This is determined by the price’s currency.
reason	nullable string	The reason for the adjustment.
item_id	nullable string	The ID of the item, as it appears on an invoice. This is only applicable for minimums.
is_invoice_level	boolean	Whether the adjustment is an invoice level adjustment or price-level adjustment.
is_trial	boolean	Whether the adjustment represents a trial discount.
plan_id	nullable string	The ID of the plan, if the adjustment is associated with a plan.
plan_phase_order	nullable int	The order of the plan phase, if the adjustment is associated with a plan and phase.
min_plan_version	nullable int	The minimum plan version, if the adjustment is associated with a plan and version.
max_plan_version	nullable int	The maximum plan version, if the adjustment is associated with a plan and version.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Adjustment Interval

Overview

The adjustment interval resource represents a time frame during which an adjustment applies to a subscription. See editing subscriptions and add or edit price intervals for more information.

Schema

Field Name	Type	Description
id	string	The ID of the adjustment interval.
updated_at	timestamp	The last updated date of the adjustment interval.
created_at	nullable timestamp	The timestamp when the adjustment interval was created.
subscription_id	string	The ID of the subscription.
customer_id	string	The ID of the customer.
adjustment_id	string	The ID of the adjustment.
applies_to_price_interval_ids	JSON	The IDs of the price intervals that the adjustment applies to.
start_time_inclusive	timestamp	The start date of the adjustment interval.
end_time_exclusive	nullable timestamp	The end date of the adjustment interval, if defined.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Billable Metric

Overview

A billable metric defines an aggregation over usage events.

Schema

Field Name	Type	Description
id	string	The ID of the billable metric.
updated_at	timestamp	The last updated date of the billable metric.
created_at	nullable timestamp	The timestamp when the billable metric was created.
metadata	json	User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary.
name	string	The user provided name of this billable metric.
description	string	The user provided description of this billable metric.
item_id	string	The id of the item, see the Item export.
status	string	Available options: active, draft, or archived.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Commitment

Overview

A commitment represents a customer’s spend commitment on a subscription, drawn down over the commitment’s term. See commitment management for more information. Drawdown activity against a commitment is captured by the Commitment Ledger Entry Event resource.

Schema

Field Name	Type	Description
id	string	The ID of the commitment.
updated_at	timestamp	The last updated date of the commitment.
created_at	nullable timestamp	The timestamp when the commitment was created.
customer_id	string	The ID of the customer.
subscription_id	string	The ID of the subscription the commitment applies to.
currency	string	The currency of the commitment.
target_amount	decimal	The target amount of the commitment, in the commitment’s currency.
commit_type	string	The type of commitment.
status	string	The status of the commitment.
drawdown_basis	string	How usage is drawn down against the commitment (for example, `post_prepaid`).
eligible_price_filters	nullable JSON	The set of filters used to scope which prices draw down against the commitment. If null, no additional scoping is applied.
start_time_inclusive	timestamp	The start date (inclusive) of the commitment.
end_time_exclusive	timestamp	The end date (exclusive) of the commitment.
true_up_invoicing_cadence_unit	nullable string	The cadence unit at which any true-up amount is invoiced, if a true-up is configured.
commitment_price_id	nullable string	The ID of the price Orb uses to bill this commitment. For commitments with a true-up, this is the true-up price.
true_up_price_id	nullable string	The ID of the price used to invoice any true-up amount, if a true-up is configured. Equivalent to `commitment_price_id`.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Commitment Ledger Entry Event

Overview

The Commitment Ledger Entry Event resource represents the operations that draw down a Commitment (for example, increments and decrements), captured as separate created and reverted events. This resource is helpful for understanding how a commitment gets burned down over time. Like the other *Event resources, entries are emitted as distinct creation and revert events (distinguished by the is_revert field). Unlike the Credit Ledger Entry Event resource, this resource does not expose a lock_adjusted_timestamp.

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the commitment ledger entry.
created_at	nullable timestamp	The timestamp when this event was created or reverted in Orb.
source_id	string	The ID of the commitment ledger entry.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
commitment_id	string	The ID of the commitment.
customer_id	string	The customer ID associated with this entry.
currency	string	The currency of the commitment ledger entry.
amount	decimal	The amount that was applied on this commitment ledger entry.
starting_balance	decimal	The beginning balance of the ledger.
ending_balance	decimal	The ending balance of the ledger.
entry_type	string	The type of the ledger entry.
ledger_sequence_number	integer	The sequence number of the ledger entry.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Coupon

Overview

A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription.

Schema

Field Name	Type	Description
id	string	The ID of the coupon.
updated_at	timestamp	The last updated date of the coupon.
created_at	nullable timestamp	The timestamp when the coupon was created.
redemption_code	string	This string can be used to redeem this coupon for a given subscription.
discount	json	A JSON blob representing either a PercentageDiscount or AmountDiscount
times_redeemed	int	The number of times this coupon has been redeemed.
duration_in_months	nullable int	This allows for a coupon’s discount to apply for a limited time (determined in months); a null value here means “unlimited time”.
max_redemptions	nullable int	The maximum number of redemptions allowed for this coupon before it is exhausted; null here means “unlimited”.
archived_at	nullable timestamp	An archived coupon can no longer be redeemed. Active coupons will have a value of null for archived_at; this field will be non-null for archived coupons.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Coupon Redemption

Overview

The Coupon Redemption resource type represents a coupon that has been redeemed by a customer.

Schema

Field Name	Type	Description
id	string	The ID of the coupon redemption.
updated_at	timestamp	The last updated date of the coupon redemption.
created_at	nullable timestamp	The timestamp when the coupon redemption was created.
start_date	timestamp	The start date of the coupon redemption.
end_date	nullable timestamp	An optional end date of the coupon redemption.
coupon_id	string	The ID of the coupon.
adjustment_id	string	The ID of the adjustment.
subscription_id	string	The ID of the subscription.
customer_id	string	The ID of the customer.
unredeemed_time	nullable timestamp	An optional timestamp of when the coupon was unredeemed, if it was unredeemed.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Credit Ledger Entry

Overview

The Credit ledger entry resource represents the various operations that occur for each credit block (e.g. increments and decrements). This resource is helpful to understand how a credit block gets burned down.

Schema

Field Name	Type	Description
id	string	The ID of the credit ledger entry.
updated_at	timestamp	The last updated date of the credit ledger entry.
created_at	timestamp	The timestamp when the credit ledger entry was created.
reverted_at	nullable timestamp	If set, the time at which this entry was reverted.
amount	string	The amount that was applied on this credit ledger entry.
credit_block	JSONB	The associated credit block for this entry
currency	string	The currency of the credit ledger entry.
customer	JSONB	The customer record associated with this entry.
description	nullable string	An optional description of the entry.
starting_balance	string	The beginning balance of the ledger.
ending_balance	string	The ending balance of the ledger.
entry_status	string	The status of the ledger entry.
entry_type	string	The type of the ledger entry.
invoice_id	nullable string	If set, the relevant invoice this entry applies to.
invoice_line_item_id	nullable string	If set, the relevant invoice line item ID this entry applies to.
ledger_sequence_number	integer	The sequence number of the ledger entry.
metadata	nullable JSON	If set, the metadata attached to this ledger entry.
new_block_expiry_date	nullable timestamp	If set, the time at which this expiry has been updated to.
price_id	nullable string	If set, the relevant price identifier.
event_id	nullable string	If set, the ID of the event associated with this ledger entry.
void_amount	nullable string	If set, the amount of the increment that was voided.
void_reason	nullable string	If set, the reason for the increment being voided.

Credit Ledger Entry Event

Overview

This resource represents the same data as Credit Ledger Entry, but also includes timestamp, lock_adjusted_timestamp, and is_revert fields, enabling the recognition of credit block operations with respect to the accounting period lock posture at the time of the operations.

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the credit ledger entry.
created_at	nullable timestamp	The timestamp when the credit ledger entry was created.
source_id	string	The ID of the credit ledger entry.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
lock_adjusted_timestamp	timestamp	The time that this entry should be recognized based on the accounting period lock posture.
amount	decimal	The amount that was applied on this credit ledger entry.
currency	string	The currency of the credit ledger entry.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
customer_id	string	The customer ID associated with this entry.
description	nullable string	An optional description of the entry.
starting_balance	decimal	The beginning balance of the ledger.
ending_balance	decimal	The ending balance of the ledger.
entry_status	string	The status of the ledger entry.
entry_type	string	The type of the ledger entry.
invoice_id	nullable string	If set, the relevant invoice this entry applies to.
invoice_line_item_id	nullable string	If set, the relevant invoice line item ID this entry applies to.
ledger_sequence_number	integer	The sequence number of the ledger entry.
block_id	nullable string	If set, the associated credit block ID for this entry.
cost_basis	nullable decimal	If set, the associated credit block cost basis for this entry.
block_expiry_date	nullable timestamp	If set, the associated credit block’s expiry date for this entry.
metadata	nullable JSON	If set, the metadata attached to this ledger entry.
new_block_expiry_date	nullable timestamp	If set, the time at which this expiry has been updated to.
price_id	nullable string	If set, the relevant price identifier.
recognized_revenue_amount	nullable decimal	If set, the converted amount recognized.
void_amount	nullable string	If set, the amount of the increment that was voided.
void_reason	nullable string	If set, the reason for the increment being voided.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Credit note

Overview

The Credit note resource type represents a credit note that has been issued to a customer. A credit note is a document that can be used to decrease the amount due or issue a credit for an already issued invoice.

Schema

Field Name	Type	Description
id	string	The ID of the credit note.
updated_at	timestamp	The last updated date of the credit note.
created_at	timestamp	The timestamp when the credit note was created.
voided_at	nullable timestamp	The time at which the credit note was voided in Orb, if applicable.
credit_note_number	string	The unique identifier for credit notes.
invoice_id	string	The id of the invoice resource that this credit note is applied to.
memo	nullable string	An optional memo supplied on the credit note.
reason	nullable string	An optional reason for the credit note. Available options: “Duplicate”, “Fraudulent”, “Order change”, “Product unsatisfactory”.
type	string	The type of credit note. Available options: `refund`, `adjustment`.
currency	string	The currency of the credit note.
subtotal	string	The total prior to any creditable invoice-level discounts or minimums.
total	string	The total including creditable invoice-level discounts or minimums, and tax.
customer_id	string	The id of the customer resource that this credit note is applied to.
credit_note_pdf	nullable string	A URL to a PDF of the credit note.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Credit Note Line Item

Overview

The Credit Note Line Item resource type represents a line item that is associated with a credit note.

Schema

Field Name	Type	Description
id	string	The ID of the credit note line item.
updated_at	timestamp	The last updated date of the credit note line item.
created_at	timestamp	The timestamp when the credit note line item was created.
voided_at	nullable timestamp	The date and time when the credit note was voided.
credit_note_id	string	The ID of the credit note.
name	string	The name of the corresponding invoice line item.
amount	string	The amount of the line item, excluding any line item minimums and discounts.
quantity	nullable number	An optional quantity credited.
tax_amounts	dict[]	Any tax amounts applied onto the line item.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
timeframe_start	nullable timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	nullable timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
line_item_id	nullable string	The ID of the line item
item_id	nullable string	The ID of the product or service item
block_id	nullable string	If set, the associated credit block ID for this line item.
total	nullable decimal	The total amount of the line item, excluding tax
total_with_tax	nullable decimal	The total amount of the line item, including tax

Credit Note Line Item Event

Overview

This resource represents the same data as Credit Note Line Item, but also includes timestamp, lock_adjusted_timestamp, and is_revert fields, enabling the recognition of credit note line items with respect to the accounting period lock posture at the time of credit note issuance.

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the credit note line item.
created_at	nullable timestamp	The timestamp when the credit note line item was created.
source_id	string	The ID of the credit note line item.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
lock_adjusted_timestamp	timestamp	The time that this entry should be recognized based on the accounting period lock posture.
credit_note_id	string	The ID of the credit note.
invoice_id	string	The ID of the associated invoice.
customer_id	nullable string	The ID of the customer.
name	string	The name of the corresponding invoice line item.
quantity	nullable number	The quantity credited.
tax_amounts	dict[]	Any tax amounts applied onto the line item.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
timeframe_start	nullable timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	nullable timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
invoice_line_item_id	nullable string	The ID of the invoice line item.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
item_id	nullable string	The ID of the product or service item.
block_id	nullable string	If set, the associated credit block ID for this line item.
total	nullable decimal	The total amount of the line item, excluding tax.
total_with_tax	nullable decimal	The total amount of the line item, including tax.

Customer Balance Transaction

Overview

The customer balance is an amount in the customer’s currency, which Orb automatically applies to subsequent invoices. This balance can be adjusted manually via Orb’s webapp on the customer details page.

Schema

Field Name	Type	Description
id	string	The ID of the customer balance transaction.
updated_at	timestamp	The last updated date of the customer balance transaction.
created_at	timestamp	The timestamp when the customer balance transaction was created.
starting_balance	decimal	The original value of the customer’s balance prior to the transaction, in the customer’s currency.
ending_balance	decimal	The new value of the customer’s balance after the transaction, in the customer’s currency.
amount	decimal	The value of the amount changed in the transaction.
action	string	Available options: `applied_to_invoice`, `manual_adjustment`, `prorated_refund`, `revert_prorated_refund`, `return_from_voiding`, `credit_note_applied`, `credit_note_voided`, `overpayment_refund`
type	string	Available options: `increment`, `decrement`
description	nullable string	An optional description provided for manual customer balance adjustments.
invoice_id	nullable string	An optional ID if there is an associated invoice.
credit_note_id	nullable string	An optional ID if there is an associated credit note.
customer_id	string	The ID of the customer.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Daily Credit Note Line Item Event

Overview

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the credit note line item.
created_at	nullable timestamp	The timestamp when the credit note line item was created.
source_id	string	The ID of the credit note line item.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
lock_adjusted_timestamp	timestamp	The time that this entry should be recognized based on the accounting period lock posture.
credit_note_id	string	The ID of the credit note.
invoice_id	string	The ID of the associated invoice.
invoice_line_item_id	nullable string	The ID of the invoice line item.
customer_id	nullable string	The ID of the customer.
invoicing_currency	nullable string	The currency used for invoicing. Since credit notes are always issued after invoice issuance, there is only ever one currency.
name	string	The name of the corresponding invoice line item.
item_id	nullable string	The ID of the product or service item.
block_id	nullable string	If set, the associated credit block ID for this line item.
timeframe_start	nullable timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	nullable timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
total	nullable decimal	The total amount of the line item, excluding tax.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Daily Line Item Revenue

Overview

The Daily Line Item Revenue resource type can be used to track the daily quantity and associated costs for invoice line items. This resource type will function similarly to the subscription costs endpoint, but with more fine grained access to information. This information can be used to power use cases like:

Daily revenue recognition workflows
Running pricing exercises

As mentioned, this resource will track daily quantities, but will reflect intra-day plan changes where applicable. This means that rows may span time periods less than a day in cases where a plan changes. Values in the export are periodic values (as opposed to cumulative values) and only relevant to the applicable timeframe. The Daily Line Item Revenue resource type is conceptually an append only resource type. Entries in this table can be reverted. For example, when a backdated operation occurs, this may result in old values changing. When entries are reverted, they will have a corresponding timestamp in their reverted_at field but will still exist in the table. This means that historical queries can be constructed to understand what values were returned in the past. The Daily Line Item Revenue resource type relies on upstream processes running to calculate these values. Importantly, this processing relies on the grace period ending before it can run. This means that entries in this resource type will be delayed. On average, we expect this delay to be approximately three days.

Schema

Field Name	Type	Description
id	string	The ID of the daily line item revenue object.
updated_at	timestamp	The last updated date of the daily line item revenue object.
created_at	nullable timestamp	The timestamp when the daily line item revenue object was created.
customer_id	string	The ID of the customer.
subscription_id	nullable string	The ID of the subscription. Note that a subscription ID may not always be present due to things like one-off invoices.
pricing_currency	string	The currency of the underlying price.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
item_id	string	The ID of the item
invoice_id	string	The ID of the invoice
invoice_line_item_id	string	The ID of the invoice line item
price_id	string	The ID of the price
billable_metric_id	nullable string	The ID of the billable metric. Note that a billable metric ID may not be present if the associated price is not usage based.
plan_id	nullable string	The ID of the plan. Note that it may not always be present due to things like one-off invoices.
timeframe_start	timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
line_item_start_date	timestamp	The start date of the associated line item.
line_item_end_date	timestamp	The end date of the associated line item.
invoice_date	nullable timestamp	The invoice date.
quantity	decimal	The price’s quantity for the relevant timeframe.
subtotal	decimal	The list price before any adjustments have been applied.
adjusted_subtotal	decimal	The list price after adjustments have been applied. Called the “total” in the subscription costs API. This has been renamed to avoid confusion.
amount	decimal	The list price after: adjustments have been applied, prepaid credits have been applied, license allocations and license overage write-offs have been applied, overage conversions have been applied, and partial invoice amounts have been applied.
rounded_amount	decimal	The amount after rounding occurs. If no rounding occurs, this value will be the same as `amount`. This value does not include tax.
credits_applied	decimal	The number of credits used.
license_allocation_applied	nullable decimal	The amount of license allocation applied to this line item. Only populated for line items whose usage drew down from a license allocation.
license_allocation_overage	nullable decimal	The license allocation overage written off for this line item. Only non-zero when the license allocation is configured to write off overage.
conversion_rate	decimal	The conversion rate between the price currency and the invoicing currency. If they are the same, this is 1.
adjustments	JSONB An array of dictionaries with: adjustment ID, adjustment type, amount, and price IDs.	The adjustments made to line items to account for maximums, minimums, and discounts.
sub_line_items	nullable JSONB If this field is null, the number of sub-line items exceeds 500. This is differentiated from cases with no sub-line items, where the column will be empty JSON.	The serialized sub-line items from the invoice. This field can contain up to 500 sub-line items for a given line item. If the number of sub-line items exceeds 500, this field will not contain any sub-line items.
is_partial_invoice	boolean	True if this line item was part of a Threshold invoice
partially_invoiced_amount	nullable decimal	If this is from a threshold invoice, the amount that was partially invoiced.
reverted_at	nullable timestamp	When this entry was reverted. Entries are reverted when backdated operations occur that change the amounts for a given invoice line item on a specified day. Entries are never deleted and are only marked as reverted to allow for historical tracking of values returned on a given day in the past. A row is valid in this table if reverted_at is null.

Daily Line Item Revenue Event

Overview

This resource represents the same data as Daily Line Item Revenue, but also includes timestamp, lock_adjusted_timestamp, and is_revert fields, enabling revenue recognition with respect to the accounting period lock posture at the time of original recognition.

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the daily line item revenue object.
created_at	nullable timestamp	The timestamp when the daily line item revenue object was created.
source_id	string	The ID of the daily line item revenue object.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
lock_adjusted_timestamp	timestamp	The time that this entry should be recognized based on the accounting period lock posture.
customer_id	string	The ID of the customer.
subscription_id	nullable string	The ID of the subscription. Note that a subscription ID may not always be present due to things like one-off invoices.
pricing_currency	string	The currency of the underlying price.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
item_id	string	The ID of the item
invoice_id	string	The ID of the invoice
invoice_line_item_id	string	The ID of the invoice line item
price_id	string	The ID of the price
billable_metric_id	nullable string	The ID of the billable metric. Note that a billable metric ID may not be present if the associated price is not usage based.
plan_id	nullable string	The ID of the plan. Note that it may not always be present due to things like one-off invoices.
timeframe_start	timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
line_item_start_date	nullable timestamp	The start date of the associated line item.
line_item_end_date	nullable timestamp	The end date of the associated line item.
invoice_date	nullable timestamp	The invoice date.
quantity	decimal	The price’s quantity for the relevant timeframe.
subtotal	decimal	The list price before any adjustments have been applied.
adjusted_subtotal	decimal	The list price after adjustments have been applied. Called the “total” in the subscription costs API. This has been renamed to avoid confusion.
amount	decimal	The list price after: adjustments have been applied, prepaid credits have been applied, license allocations and license overage write-offs have been applied, overage conversions have been applied, and partial invoice amounts have been applied.
rounded_amount	decimal	The amount after rounding occurs. If no rounding occurs, this value will be the same as `amount`. This value does not include tax.
correction_amount	nullable decimal	The amount of corrections applied to the line item, reflected in `rounded_amount`.
credits_applied	decimal	The number of credits used.
license_allocation_applied	nullable decimal	The amount of license allocation applied to this line item. Only populated for line items whose usage drew down from a license allocation.
license_allocation_overage	nullable decimal	The license allocation overage written off for this line item. Only non-zero when the license allocation is configured to write off overage.
conversion_rate	decimal	The conversion rate between the price currency and the invoicing currency. If they are the same, this is 1.
adjustments	JSONB An array of dictionaries with: adjustment ID, adjustment type, amount, and price IDs.	The adjustments made to line items to account for maximums, minimums, and discounts.
sub_line_items	nullable JSONB If this field is null, the number of sub-line items exceeds 500. This is differentiated from cases with no sub-line items, where the column will be empty JSON.	The serialized sub-line items from the invoice. This field can contain up to 500 sub-line items for a given line item. If the number of sub-line items exceeds 500, this field will not contain any sub-line items.
is_partial_invoice	boolean	True if this line item was part of a Threshold invoice
partially_invoiced_amount	nullable decimal	If this is from a threshold invoice, the amount that was partially invoiced.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Dimensional Price Group

Overview

The dimensional price group resource represents a dimensional price group that can be reused across prices and plans. See Create dimensional price group for more information. The dimensional price group table is most useful when joining with the Price table using the dimensional_price_group_id field. For example, you can use dimensional_price_group_id in the Price schema above to understand which prices partition the same billable metric (and by which dimensions), and use the dimension_values in the Price schema to understand which partition a particular price represents.

Schema

Field Name	Type	Description
id	string	The ID of the dimensional price group.
updated_at	timestamp	The last updated date of the dimensional price group.
created_at	timestamp	The timestamp when the dimensional price group was created.
name	string	The name of the price group.
external_dimensional_price_group_id	nullable string	The ID of the price group in the external system.
billable_metric_id	string	The ID of the billable metric that the price group partitions
dimensions	JSON (array of strings)	The dimensions that the price group partitions
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Invoice Line Item Billing

Overview

The Invoice Line Item Billing resource type can be used to track the individual line item values for invoices that have been issued / billed. This information can be used to power use cases like:

Calculating the precise amounts discounted per line item
Breaking down the amounts billed for a specific price or billable metric

The Invoice Line Item Billing resource type is conceptually an append only resource type. There are infrequent cases where entries can be voided (usually from a requested manual intervention). If this has occurred, it will be reflected in the voided_at column. The Invoice Line Item Revenue resource type relies on an invoice being issued before rows are written. Importantly, invoice issuing relies on the grace period ending before it can occur. This means that entries in this resource type will be delayed.

Schema

Field Name	Type	Description
id	string	The ID of the invoice line item billing object.
updated_at	timestamp	The last updated date of the invoice line item billing object.
created_at	nullable timestamp	The timestamp when the invoice line item billing object was created.
customer_id	string	The ID of the customer.
subscription_id	nullable string	The ID of the subscription. Note that a subscription ID may not always be present due to things like one-off invoices.
pricing_currency	string	The currency of the underlying price.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
item_id	string	The ID of the item
invoice_id	string	The ID of the invoice
invoice_line_item_id	string	The ID of the invoice line item
price_id	string	The ID of the price
billable_metric_id	nullable string	The ID of the billable metric. Note that a billable metric ID may not be present if the associated price is not usage based.
plan_id	nullable string	The ID of the plan. Note that it may not always be present due to things like one-off invoices.
block_id	nullable string	If set, the associated credit block ID for this line item.
invoice_date	nullable timestamp	The invoice date.
timeframe_start	timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
quantity	decimal	The price’s quantity for the relevant timeframe.
subtotal	decimal	The list price before any adjustments have been applied.
adjusted_subtotal	decimal	The list price after adjustments have been applied. Called the “total” in the subscription costs API. This has been renamed to avoid confusion.
amount	decimal	The list price after: adjustments have been applied, prepaid credits have been applied, license allocations and license overage write-offs have been applied, overage conversions have been applied, and partial invoice amounts have been applied.
rounded_amount	decimal	The amount after rounding occurs. If no rounding occurs, this value will be the same as `amount`. This value does not include tax.
tax_amount	decimal	The tax amount calculated for this line item.
credits_applied	decimal	The number of credits used.
license_allocation_applied	nullable decimal	The amount of license allocation applied to this line item. Only populated for line items whose usage drew down from a license allocation.
license_allocation_overage	nullable decimal	The license allocation overage written off for this line item. Only non-zero when the license allocation is configured to write off overage.
conversion_rate	decimal	The conversion rate between the price currency and the invoicing currency. If they are the same, this is 1.
adjustments	JSONB An array of dictionaries with: adjustment ID, adjustment type, amount, and price IDs.	The adjustments made to line items to account for maximums, minimums, and discounts.
sub_line_items	nullable JSONB If this field is null, the number of sub-line items exceeds 500. This is differentiated from cases with no sub-line items, where the column will be empty JSON.	The serialized sub-line items from the invoice. This field can contain up to 500 sub-line items for a given line item. If the number of sub-line items exceeds 500, this field will not contain any sub-line items.
is_partial_invoice	boolean	True if this line item was part of a Threshold invoice
partially_invoiced_amount	nullable decimal	If this is from a threshold invoice, the amount that was partially invoiced.
voided_at	nullable timestamp	When this entry was voided. Entries are very infrequently voided and usually correspond to manual actions that have taken place at the request of the customer.

Invoice Line Item Billing Event

Overview

This resource represents the same data as Invoice Line Item Billing, but also includes timestamp, lock_adjusted_timestamp, and is_revert fields, enabling revenue recognition with respect to the accounting period lock posture at the time of original issuance.

Schema

Field Name	Type	Description
id	string	A composite ID of the form `{source_id}-{is_revert}`.
updated_at	timestamp	The last updated date of the invoice line item billing object.
created_at	nullable timestamp	The timestamp when the invoice line item billing object was created.
source_id	string	The ID of the invoice line item billing entry.
is_revert	boolean	Whether this entry represents a creation or revert event.
timestamp	timestamp	The original time that this entry was created or reverted in Orb.
lock_adjusted_timestamp	timestamp	The time that this entry should be recognized based on the accounting period lock posture.
customer_id	string	The ID of the customer.
subscription_id	nullable string	The ID of the subscription. Note that a subscription ID may not always be present due to things like one-off invoices.
pricing_currency	string	The currency of the underlying price.
invoicing_currency	nullable string	The currency used for invoicing if it differs from the price’s currency. Today, this only occurs if you are using virtual pricing units.
item_id	string	The ID of the item
invoice_id	string	The ID of the invoice
invoice_line_item_id	string	The ID of the invoice line item
price_id	string	The ID of the price
billable_metric_id	nullable string	The ID of the billable metric. Note that a billable metric ID may not be present if the associated price is not usage based.
plan_id	nullable string	The ID of the plan. Note that it may not always be present due to things like one-off invoices.
block_id	nullable string	If set, the associated credit block ID for this line item.
timeframe_start	timestamp	The inclusive timestamp for the start of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
timeframe_end	timestamp	The exclusive timestamp for the end of the relevant period. Note that entries are scoped to day boundaries, but may start or end in the middle of the day if a plan change occurs.
invoice_date	nullable timestamp	The invoice date.
quantity	decimal	The price’s quantity for the relevant timeframe.
subtotal	decimal	The list price before any adjustments have been applied.
adjusted_subtotal	decimal	The list price after adjustments have been applied. Called the “total” in the subscription costs API. This has been renamed to avoid confusion.
amount	decimal	The list price after: adjustments have been applied, prepaid credits have been applied, license allocations and license overage write-offs have been applied, overage conversions have been applied, and partial invoice amounts have been applied.
rounded_amount	decimal	The amount after rounding occurs. If no rounding occurs, this value will be the same as `amount`. This value does not include tax.
correction_amount	nullable decimal	The amount of corrections applied to the line item, reflected in `rounded_amount`.
tax_amount	decimal	The tax amount calculated for this line item.
credits_applied	decimal	The number of credits used.
license_allocation_applied	nullable decimal	The amount of license allocation applied to this line item. Only populated for line items whose usage drew down from a license allocation.
license_allocation_overage	nullable decimal	The license allocation overage written off for this line item. Only non-zero when the license allocation is configured to write off overage.
conversion_rate	decimal	The conversion rate between the price currency and the invoicing currency. If they are the same, this is 1.
adjustments	JSONB An array of dictionaries with: adjustment ID, adjustment type, amount, and price IDs.	The adjustments made to line items to account for maximums, minimums, and discounts.
sub_line_items	nullable JSONB If this field is null, the number of sub-line items exceeds 500. This is differentiated from cases with no sub-line items, where the column will be empty JSON.	The serialized sub-line items from the invoice. This field can contain up to 500 sub-line items for a given line item. If the number of sub-line items exceeds 500, this field will not contain any sub-line items.
is_partial_invoice	boolean	True if this line item was part of a Threshold invoice
partially_invoiced_amount	nullable decimal	If this is from a threshold invoice, the amount that was partially invoiced.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Invoice Metadata

Overview

The Invoice Metadata resource represents a subset of data from the invoice resource. This resource also exposes draft invoices within Orb, which can be deleted at any time.

Schema

Field Name	Type	Description
id	string	The ID of the invoice.
updated_at	timestamp	The last updated date of the invoice.
created_at	timestamp	The timestamp when the invoice was created.
currency	string	The currency of the invoice.
customer_id	string	The ID of the customer.
due_date	nullable timestamp	The time the invoice must be paid by.
invoice_date	timestamp	An optional invoice date set on creation.
invoice_number	nullable string	The identifying invoice number.
invoice_type	string	The type of invoice, either “one_off” or “subscription”.
issued_at	nullable timestamp	The time the invoice was sent out.
memo	nullable string	The optional memo for the reason for the invoice.
paid_at	nullable timestamp	The time that the invoice was paid.
plan_id	nullable string	The ID of the plan. Note that it may not always be present due to things like one-off invoices.
status	string	The current status indicator for the invoice.
subscription_id	nullable string	The ID of the subscription.
total	nullable decimal	The total value for the invoice. Note that this represents a point-in-time amount for draft invoices and is subject to change.
total_with_tax	nullable decimal	The total value for the invoice including tax. Note that this amount will be null for draft invoices.
amount_due	nullable decimal	The total amount due for the invoice after credit note and customer balance application. Note that this amount will be null for draft invoices.
voided_at	nullable timestamp	The time the invoice was voided.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Payment Application

Overview

The Payment Application resource represents the application of a successful payment to an invoice. This resource tracks how payments are allocated to invoices, linking each application to the payment attempt that generated it.

Schema

Field Name	Type	Description
id	string	The ID of the payment application.
updated_at	timestamp	The last updated time of the payment application.
created_at	nullable timestamp	The timestamp when the payment application was created.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
invoice_id	string	The ID of the invoice this payment application is associated with.
applied_at	timestamp	The time when the payment was applied to the invoice.
currency	string	The currency of the payment application.
amount	decimal	The amount of the payment that was applied to the invoice.
payment_attempt_id	string	The ID of the payment attempt that resulted in this payment application.

Payment Attempt

Overview

The Payment Attempt resource represents each attempt to collect payment. This resource tracks the lifecycle of payment collection efforts, including automatic retries through Orb’s dunning process. Each payment attempt captures information about when the attempt was made, the payment provider used, the result of the attempt, and any associated error information.

Schema

Field Name	Type	Description
id	string	The ID of the payment attempt.
updated_at	timestamp	The last updated time of the payment attempt.
created_at	nullable timestamp	The timestamp when the payment attempt was created.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
customer_id	string	The ID of the customer.
attempted_at	timestamp	The time when the payment attempt was made.
settled_at	nullable timestamp	The time when the payment was settled, if applicable.
provider	string	The payment provider used for this attempt. Available options: `stripe`, `adyen`, `orb`.
initiating_action	string	The action that initiated this payment attempt. Available options: `auto_collection`, `dunning`, `stripe_user_payment` (for Stripe), `manual_action` (for Orb).
status	string	The status of the payment attempt. Available options: `started`, `processing`, `failed`, `success`, `canceled`.
currency	string	The currency of the payment attempt.
amount	decimal	The amount that was attempted to be collected.
amount_captured	nullable decimal	The amount that was successfully captured.
reference_id	nullable string	An external reference ID for the payment attempt. For Stripe, this is the PaymentIntent ID. For Orb, this can be a user-provided reference ID.
payment_method_type	nullable string	The type of payment method used for this attempt. Available options: `card`, `us_bank_account`, `link`, `amazon_pay`.
description	nullable string	A description of the payment attempt.
error_details	nullable JSON	Error details returned by the payment processor, if the attempt failed. Contains structured error information including codes and messages.

Item

Overview

The Item resource type represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes.

Schema

Field Name	Type	Description
id	string	The ID of the item.
updated_at	timestamp	The last updated date of the item.
created_at	nullable timestamp	The timestamp when the item was created.
name	string	The name of the item.
external_connections	JSONB An array of dictionaries with: external_connection_name and external_entity_id	A list of connections to external third-party providers, including provider names and external entity IDs.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
archived_at	nullable timestamp	The time the item was archived. This field will be non-null for archived items.

License

Overview

The License resource represents an entitlement provisioned on a subscription. Use this resource with License Type to reconstruct which entitlements were active on a subscription and when.

Schema

Field Name	Type	Description
id	string	The ID of the license.
updated_at	timestamp	The last updated date of the license.
created_at	timestamp	The timestamp when the license was created.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
subscription_id	string	The ID of the subscription associated with the license.
license_type_id	string	The ID of the license type associated with the license.
external_license_id	string	The external identifier for the license. If the license has multiple external IDs, this is the sorted, pipe-joined string used by the License API resource.
start_time_inclusive	timestamp	The inclusive timestamp when the license becomes valid.
end_time_exclusive	nullable timestamp	The exclusive timestamp when the license is no longer valid, if defined.
effective_start_time_inclusive	nullable timestamp	The inclusive timestamp when the license becomes effective for billing calculations.
effective_end_time_exclusive	nullable timestamp	The exclusive timestamp when the license is no longer effective for billing calculations, if defined.

License Type

Overview

The License Type resource represents a named license configuration and the grouping key Orb uses to attribute usage to individual licenses.

Schema

Field Name	Type	Description
id	string	The ID of the license type.
updated_at	timestamp	The last updated date of the license type.
created_at	timestamp	The timestamp when the license type was created.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.
grouping_key	string	The event property Orb uses to attribute usage events to a license for this license type.
name	string	The user provided name of this license type.

Price

Overview

The price resource represents a price that can be associated with a plan, subscription, or invoice. See the Price configuration for more information. The price table is most useful when joining with other tables using the price_id field. For example,

you can see price_id used in the Daily Line Item Revenue schema above to understand which price configuration generated specific revenue entries.
you can see price_id used in the Invoice Line Item Billing schema above to understand which price configuration generated specific invoice line item values.

Schema

Field Name	Type	Description
id	string	The ID of the price.
updated_at	timestamp	The last updated date of the price.
created_at	timestamp	The timestamp when the price was created.
name	string	The name of the price.
external_price_id	nullable string	The ID of the price in the external system.
price_type	string	The type of price. Can be either “usage_price” or “fixed_price”.
cadence	string	The cadence of the price. Can be “one-time”, “monthly”, “quarterly”, “semi-annual”, “annual”, or “custom”.
billing_mode	string	The billing mode of the price. Can be “in_advance” or “in_arrear”.
billing_cycle_duration	nullable decimal	The duration of the billing cycle.
billing_cycle_duration_unit	string	The unit of the billing cycle duration. Can be “day” or “month”.
invoicing_cycle_duration	nullable decimal	The duration of the invoicing cycle.
invoicing_cycle_duration_unit	nullable string	The unit of the invoicing cycle duration. Can be “day” or “month”.
billable_metric_id	nullable string	The ID of the billable metric. This is only present if the price is usage based.
fixed_price_quantity	nullable decimal	The quantity of the price. This is only present if the price is fixed.
currency	string	The currency of the price.
conversion_rate	nullable decimal	The conversion rate of the price.
item_id	string	The ID of the item.
credit_allocation	nullable JSON	The credit allocation of the price.
license_allocations	nullable JSON	The license allocations configured on the price, as an array of objects with `id`, `amount`, `currency`, and `write_off_overage`.
model_type	string	The model type of the price. Can be “tiered”, “volume”, “matrix”, “tier_volume”, etc. See Price configuration for the full list.
rating_config	JSON	The rating configuration of the price.
plan_id	nullable string	The ID of the plan, if the price is associated with a plan.
plan_phase_order	nullable int	The order of the plan phase, if the price is associated with a plan and phase.
dimensional_price_group_id	nullable string	The ID of the dimensional price group this price represents a partition of, if the price is associated with a dimensional price group.
dimension_values	nullable JSON (array of strings)	The dimension values this price partitions the metric by, if the price is associated with a dimensional price group.
composite_price_filters	nullable JSON	The set of filters used to scope eligible prices if this is a composite price.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Price Interval

Overview

The price interval resource represents a time frame during which a price applies to a subscription. See editing subscriptions and add or edit price intervals for more information.

Schema

Field Name	Type	Description
id	string	The ID of the price interval.
updated_at	timestamp	The last updated date of the price interval.
created_at	nullable timestamp	The timestamp when the price interval was created.
subscription_id	string	The ID of the subscription.
customer_id	string	The ID of the customer.
price_id	string	The ID of the price.
start_date_inclusive	timestamp	The start date of the price interval.
end_date_exclusive	nullable timestamp	The end date of the price interval, if defined.
billing_cycle_day	number	The day of the billing cycle.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Subscription version

Overview

The subscription version resource represents the subscription schedule for a given subscription, allowing for an understanding of underlying plan transitions. A given subscription may have multiple subscription versions mapped to it to track plan version changes and more.

Schema

Field Name	Type	Description
id	string	The ID of the subscription version.
updated_at	timestamp	The last updated date of the subscription version.
created_at	nullable timestamp	The timestamp when the subscription version was created.
subscription_id	string	The ID of the subscription.
customer_id	string	The ID of the customer.
plan	JSON	The plan information associated with this subscription version.
start_date	timestamp	The time when this subscription version started.
ended_at	nullable timestamp	If set, the time when this subscription version ended.
subscription_start_date	timestamp	the timestamp when this subscription started.
subscription_ended_at	nullable timestamp	If set, the time when this subscription ended.
modified_at	timestamp	The time when this resource was last modified in Orb’s system.
deleted_at	nullable timestamp	Deletion marker for this resource. If not null, then the resource has been deleted as of the time set.

Legacy resources (deprecated)

Orb periodically deprecates older data export resources that no longer meet the product and infrastructure standards we require to support accurate reporting, scalable workloads, or new functionality. What you can expect from end of service:

This resource will no longer appear in the in-app UI, including the configuration table in settings.
It will no longer be configurable for new connections—customers cannot create or enable new exports using the deprecated resource.
Existing connections will stop syncing, meaning no new or updated data will flow to destinations after the deprecation date. Previously synced data will remain in your data warehouse.

Resource type	Deprecation date	Alternative resources
Invoice	Nov 26, 2025	Invoice metadata, Payment attempt, Payment application Note: the Invoice API endpoint remains fully servicable for non-reporting applications.

​Resources

​General guidance

​API-based resources

​List of resources

​Nested resources

​Resource schemas

​Accounting Period Lock

​Overview

​Schema

​Adjustment

​Overview

​Schema

​Adjustment Interval

​Overview

​Schema

​Billable Metric

​Overview

​Schema

​Commitment

​Overview

​Schema

​Commitment Ledger Entry Event

​Overview

​Schema

​Coupon

​Overview

​Schema

​Coupon Redemption

​Overview

​Schema

​Credit Ledger Entry

​Overview

​Schema

​Credit Ledger Entry Event

​Overview

​Schema

​Credit note

​Overview

​Schema

​Credit Note Line Item

​Overview

​Schema

​Credit Note Line Item Event

​Overview

​Schema

​Customer Balance Transaction

​Overview

​Schema

​Daily Credit Note Line Item Event

​Overview

​Schema

​Daily Line Item Revenue

​Overview

​Schema

​Daily Line Item Revenue Event

​Overview

​Schema

​Dimensional Price Group

​Overview

​Schema

​Invoice Line Item Billing

​Overview

​Schema

​Invoice Line Item Billing Event

​Overview

​Schema

​Invoice Metadata

​Overview

​Schema

​Payment Application

​Overview

​Schema

​Payment Attempt

​Overview

​Schema

​Item

​Overview

​Schema

​License

​Overview

Resources

General guidance

API-based resources

List of resources

Nested resources

Resource schemas

Accounting Period Lock

Overview

Schema

Adjustment

Overview

Schema

Adjustment Interval

Overview

Schema

Billable Metric

Overview

Schema

Commitment

Overview

Schema

Commitment Ledger Entry Event

Overview

Schema

Coupon

Overview

Schema

Coupon Redemption

Overview

Schema

Credit Ledger Entry

Overview

Schema

Credit Ledger Entry Event

Overview

Schema

Credit note

Overview

Schema

Credit Note Line Item

Overview

Schema

Credit Note Line Item Event

Overview

Schema

Customer Balance Transaction

Overview

Schema

Daily Credit Note Line Item Event

Overview

Schema

Daily Line Item Revenue

Overview

Schema

Daily Line Item Revenue Event

Overview

Schema

Dimensional Price Group

Overview

Schema

Invoice Line Item Billing

Overview

Schema

Invoice Line Item Billing Event

Overview

Schema

Invoice Metadata

Overview

Schema

Payment Application

Overview

Schema

Payment Attempt

Overview

Schema

Item

Overview

Schema

License

Overview