Schema - Orb

Customer

An Orb customer resource is synced to Salesforce as a custom object OrbCustomer with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
additional_emails	Additional Emails	AdditionalEmails	Text Area (Long)
auto_collection	Auto-Collection	AutoCollection	Text
balance	Balance	Balance	Text
billing_address	Billing Address	BillingAddress	Text Area (Long)
created_at	Created At	CreatedAt	DateTime
currency	Currency	Currency	Text
deleted_at	Deleted At	DeletedAt	DateTime
email	Email	Email	Email
email_delivery	Email Delivery	EmailDelivery	Text
exempt_from_automated_tax	Exempt From Automated Tax	ExemptFromAutomatedTax	Text
external_customer_id	External Customer ID	ExternalCustomerId	Text
metadata	Metadata	Metadata	Text Area (Long)
name	Name	Name	Text
payment_provider	Payment Provider	PaymentProvider	Text
payment_provider_id	Payment Provider ID	PaymentProviderId	Text
portal_url	Portal URL	PortalUrl	URL
shipping_address	Shipping Address	ShippingAddress	Text Area (Long)
tax_id	Tax ID	TaxId	Text
timezone	Timezone	Timezone	Text
updated_at	Updated At	UpdatedAt	DateTime

Plan

An Orb plan resource is synced to Salesforce as a custom object OrbPlan with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
created_at	Created At	CreatedAt	DateTime
default_invoice_memo	Default Invoice Memo	DefaultInvoiceMemo	Text
deleted_at	Deleted At	DeletedAt	DateTime
description	Description	Description	Text
discount	Discount	Discount	Text Area (Long)
external_plan_id	External Plan ID	ExternalPlanId	Text
invoicing_currency	Invoicing Currency	InvoicingCurrency	Text
maximum	Maximum	Maximum	Text Area (Long)
metadata	Metadata	Metadata	Text Area (Long)
minimum	Minimum	Minimum	Text Area (Long)
name	Name	Name	Text
net_terms	Net Terms	NetTerms	Number
product	Product	Product	Text Area (Long)
status	Status	Status	Text
trial_config	Trial Config	TrialConfig	Text Area (Long)
updated_at	Updated At	UpdatedAt	DateTime
version	Version	Version	Number

Subscription

An Orb subscription resource is synced to Salesforce as a custom object OrbSubscription with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
active_plan_phase_order	Active Plan Phase Order	ActivePlanPhaseOrder	Number
auto_collection	Auto-Collection	AutoCollection	Text
billing_cycle_day	Billing Cycle Day	BillingCycleDay	Number
created_at	Created At	CreatedAt	DateTime
current_billing_period_start_date	Current Billing Period Start Date	CurrentBillingPeriodStartDate	DateTime
current_billing_period_end_date	Current Billing Period End Date	CurrentBillingPeriodEndDate	DateTime
customer_id	Customer	Customer	Lookup (Orb Customer)
default_invoice_memo	Default Invoice Memo	DefaultInvoiceMemo	Text
deleted_at	Deleted At	DeletedAt	DateTime
description	Description	Description	Text
discount	Discount	Discount	Text Area (Long)
end_date	End Date	EndDate	DateTime
invoicing_threshold	Invoicing Threshold	InvoicingThreshold	Text
maximum	Maximum	Maximum	Text Area (Long)
metadata	Metadata	Metadata	Text Area (Long)
minimum	Minimum	Minimum	Text Area (Long)
net_terms	Net Terms	NetTerms	Number
plan_id	Plan	Plan	Lookup (Orb Plan)
start_date	Start Date	StartDate	DateTime
status	Status	Status	Text
trial_info	Trial Info	TrialInfo	Text Area (Long)
updated_at	Updated At	UpdatedAt	DateTime

Subscription Version

An Orb subscription version resource is synced to Salesforce as a custom object OrbSubscriptionVersion with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
customer_id	Customer	Customer	Lookup (Orb Customer)
deleted_at	Deleted At	DeletedAt	DateTime
ended_at	Ended At	EndedAt	DateTime
modified_at	Modified At	ModifiedAt	DateTime
plan_id	Plan	Plan	Lookup (Orb Plan)
start_date	Start Date	StartDate	DateTime
subscription_id	Subscription	Subscription	Lookup (Orb Subscription)
subscription_ended_at	Subscription Ended At	SubscriptionEndedAt	DateTime
subscription_start_date	Subscription Start Date	SubscriptionStartDate	DateTime
updated_at	Updated At	UpdatedAt	DateTime

Invoice

An Orb invoice resource is synced to Salesforce as a custom object OrbInvoice with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
created_at	Created At	CreatedAt	DateTime
customer_id	Customer	Customer	Lookup (Orb Customer)
currency	Currency	Currency	Text
deleted_at	Deleted At	DeletedAt	DateTime
due_date	Due Date	DueDate	DateTime
invoice_number	Invoice Number	InvoiceNumber	Text
invoice_type	Invoice Type	InvoiceType	Text
issued_at	Issued At	IssuedAt	DateTime
memo	Memo	Memo	Text
paid_at	Paid At	PaidAt	DateTime
plan_id	Plan	Plan	Lookup (Orb Plan)
status	Status	Status	Text
subscription_id	Subscription	Subscription	Lookup (Orb Subscription)
total	Total	Total	Number
updated_at	Updated At	UpdatedAt	DateTime
voided_at	Voided At	VoidedAt	DateTime

Invoice Line Item Billing

An Orb invoice line item resource is synced to Salesforce as a custom object OrbInvoiceLineItemBilling with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
adjusted_subtotal	Adjusted Subtotal	AdjustedSubtotal	Number
amount	Amount	Amount	Number
billable_metric_id	Orb Billable Metric ID	BillableMetricId	Text
conversion_rate	Conversion Rate	ConversionRate	Number
correction_amount	Correction Amount	CorrectionAmount	Number
credits_applied	Credits Applied	CreditsApplied	Number
created_at	Created At	CreatedAt	DateTime
customer_id	Customer	Customer	Lookup (Orb Customer)
deleted_at	Deleted At	DeletedAt	DateTime
invoice_id	Invoice	Invoice	Lookup (Orb Invoice)
invoice_line_item_id	Orb Invoice Line Item ID	InvoiceLineItemId	Text
item_id	Orb Item ID	ItemId	Text
invoicing_currency	Invoicing Currency	InvoicingCurrency	Text
is_partial_invoice	Is Partial Invoice	IsPartialInvoiceID	Text
name	Name	Name	Text
price_id	Orb Price ID	PriceId	Text
partially_invoiced_amount	Partially Invoiced Amount	PartiallyInvoicedAmount	Number
plan_id	Plan	Plan	Lookup (Orb Plan)
pricing_currency	Pricing Currency	PricingCurrency	Text
quantity	Quantity	Quantity	Number
subscription_id	Subscription	Subscription	Lookup (Orb Subscription)
subtotal	Subtotal	Subtotal	Number
tax_amount	Tax Amount	TaxAmount	Number
timeframe_end	Timeframe End	TimeframeEnd	DateTime
timeframe_start	Timeframe Start	TimeframeStart	DateTime
updated_at	Updated At	UpdatedAt	DateTime
voided_at	Voided At	VoidedAt	DateTime

Daily Line Item Revenue

An Orb daily line item revenue resource is synced to Salesforce as a custom object OrbDailyLineItemRevenue with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
adjusted_subtotal	Adjusted Subtotal	AdjustedSubtotal	Number
amount	Amount	Amount	Number
billable_metric_id	Orb Billable Metric ID	BillableMetricId	Text
conversion_rate	Conversion Rate	ConversionRate	Number
correction_amount	Correction Amount	CorrectionAmount	Number
credits_applied	Credits Applied	CreditsApplied	Number
created_at	Created At	CreatedAt	DateTime
customer_id	Customer	Customer	Lookup (Orb Customer)
deleted_at	Deleted At	DeletedAt	DateTime
invoice_id	Invoice	Invoice	Lookup (Orb Invoice)
invoice_line_item_id	Orb Invoice Line Item ID	InvoiceLineItemId	Text
item_id	Orb Item ID	ItemId	Text
invoicing_currency	Invoicing Currency	InvoicingCurrency	Text
is_partial_invoice	Is Partial Invoice	IsPartialInvoiceId	Text
name	Name	Name	Text
price_id	Orb Price ID	PriceId	Text
partially_invoiced_amount	Partially Invoiced Amount	PartiallyInvoicedAmount	Number
plan_id	Plan	Plan	Lookup (Orb Plan)
pricing_currency	Pricing Currency	PricingCurrency	Text
quantity	Quantity	Quantity	Number
reverted_at	Reverted At	RevertedAt	DateTime
subscription_id	Subscription	Subscription	Lookup (Orb Subscription)
subtotal	Subtotal	Subtotal	Number
timeframe_end	Timeframe End	TimeframeEnd	DateTime
timeframe_start	Timeframe Start	TimeframeStart	DateTime
updated_at	Updated At	UpdatedAt	DateTime

Committed Ledger Entry

An Orb committed ledger entry resource is synced to Salesforce as a custom object OrbCommittedLedgerEntry with the following schema:

Orb Field Name	Salesforce Field Label	Salesforce Field Name	Datatype
id	Orb ID	Id	Text
adjusted_subtotal	Adjusted Subtotal	AdjustedSubtotal	Number
amount	Amount	Amount	Number
created_at	Created At	CreatedAt	DateTime
credit_block	Credit Block	CreditBlock	Text Area (Long)
currency	Currency	Currency	Text
customer_id	Customer	Customer	Lookup (Orb Customer)
deleted_at	Deleted At	DeletedAt	DateTime
description	Description	Description	Text
ending_balance	Ending Balance	EndingBalance	Text
entry_status	Entry Status	EntryStatus	Text
entry_type	Entry Type	EntryType	Text
event_id	Orb Event ID	EventId	Text
invoice_id	Invoice	Invoice	Lookup (Orb Invoice)
ledger_sequence_number	Ledger Sequence Number	LedgerSequenceNumber	Number
metadata	Metadata	Metadata	Text Area (Long)
name	Name	Name	Text
new_block_expiry_date	New Block Expiry Date	NewBlockExpiryDate	DateTime
price_id	Orb Price ID	PriceId	Text
reverted_at	Reverted At	RevertedAt	DateTime
starting_balance	Starting Balance	StartingBalance	Text
updated_at	Updated At	UpdatedAt	DateTime
void_amount	Void Amount	VoidAmount	Text
void_reason	Void Reason	VoidReason	Text

Integrations and exports

​Customer

​Plan

​Subscription

​Subscription Version

​Invoice

​Invoice Line Item Billing

​Daily Line Item Revenue

​Committed Ledger Entry