Organizations

Billing Model

object "billing"
The description of the model.

managing_organization_id string
The ID of the organization managing this billing account, if applicable.

collect_automatically boolean
Indicates if invoices are automatically collected using the default payment method.

credits integer
The value (in cents) of credits allocated to this account, applied before billing payment methods.

delinquent boolean
Indicates if the account is late on payments.

discounts BillingDiscount[]
The discounts applied to this account. This is typically applicable for enterprise plans with large volume commitments. See Billing Discount Model for more details.

downgraded_plan string
The plan to which the organization will be downgraded at the end of the billing cycle, if a downgrade was requested.

fees BillingFee[]
Any one-time fees that will be charged at the next billing cycle. See Billing Fee Model for more details.

interval string
The frequency of the billing cycle (e.g., "month", "quarter", "year").

ai_sdk AI SDK
Comprehensive configuration for AI SDK features and models. See AI SDK Model for more details.

sms object
Provides crucial information related to the organization's usage and pricing of SMS services. See Object Details

address_validations object
Provides essential information about the organization's usage and pricing of address validation services. See Object Details

tenants object
Provides key information about the organization's usage and pricing of tenant management services. See Object Details

assets object
The assets object provides crucial information about the organization's usage and pricing of asset management services. See Object Details

containers object
The containers object provides crucial information about the organization's usage and pricing of container management services. See Object Details

deliveries object
The deliveries object provides crucial information about the organization's usage and pricing of delivery management services. See Object Details

fulfillments object
The fulfillments object provides crucial information about the organization's usage and pricing of fulfillment management services. See Object Details

items object
The items object provides crucial information about the organization's usage and pricing of item management services. See Object Details

manifests object
The manifests object provides crucial information about the organization's usage and pricing of manifest management services. See Object Details

routes object
The routes object provides crucial information about the organization's usage and pricing of route management services. See Object Details

scans object
The scans object provides crucial information about the organization's usage and pricing of scan management services. See Object Details

shipments object
The shipments object provides crucial information about the organization's usage and pricing of shipment management services. See Object Details

trackers object
The trackers object provides crucial information about the organization's usage and pricing of tracker management services. See Object Details

next_billable_month integer
A value between 1 - 12 for the next month this account will be billed. Invoices are generated on the 1st of the month.

payment_method string|null
the ID of the payment method used for automatic collections when collect_automatically is true. It may be null if no payment method has been set.

payment_processing Object
Details of payment processing fees for various transaction types.

payment_terms string
The duration until an invoice should be paid after generation. When collect_automatically is enabled, this is typically set to null.

plan string
The current plan of the organization. Options include starter, professional, and enterprise

price integer
The base price of the plan in cents, excluding any discounts or fees.

prorated_at Integer
For new organizations, this is the time in epoch seconds when the organization signed up and the billing cycle started.

tax_percent float
The percentage of tax charged on the total invoice amount.

# AI SDK Model

enabled boolean
Indicates if the AI SDK is currently enabled for the organization.

in_cloud boolean
Whether cloud-based AI processing is enabled. Defaults to false

on_device boolean
Whether on-device AI processing is enabled. Defaults to false

license_required boolean
Whether a license is required to use the AI SDK. Defaults to true

license_expires_at date
The expiration date of the current AI SDK license.

telemetry_rate number
Specifies the frequency at which usage and performance data is collected from the AI SDK.

connect_frequency number
Determines how often the SDK should establish a connection with the cloud services.

max_inactivity_time number
The maximum duration of inactivity allowed before the SDK is automatically disabled.

max_offline_time number
The maximum duration the SDK can operate without connecting to the cloud before being disabled.

features object
A collection of boolean flags indicating which AI capabilities are enabled for the organization.

models object
A comprehensive list of AI models available to the organization.

Following model types follow the below structure

• shipping_label
• bill_of_lading
• item_label
• document_classification
• barcode_detection
• document_detection
• invoice_receipt
• key_values
• ocr_detection
• ocr_recognition

The image object for each model type contains boolean flags for different model sizes:

# Billing Usage Model

price number
Represents the unit price for the service.

interval_count number
It tracks the number of units consumed or used during the current billing interval.

total_count number
It represents the cumulative number of units consumed or used since the account's inception.

# Billing Discount Model

name string
The name of the discount.

percent float
The percentage this discount reduces.

max_amount integer
The maximum amount this discount will reduce, in cents.

order integer
The order in which this discount is applied if there are multiple.

# Billing Fee Model

name string
The name of the discount.

amount integer
The amount that will be charged in cents.

invoice_id integer
The invoice to which this fee was applied.

is_taxable boolean
If tax should be collected on this fee.