Organizations
Model
Organization Model
object "organization"
The description of the model.
active boolean
if this organization is currently active.
billing
Billing
Time in epoch seconds when this resource was created.
currency string
The three-letter ISO string for the currency. Currently all accounts should be set to "usd".
created_at Integer
Seconds from epoch when this rate was created.
enable_scoped_payment_methods boolean
For enterprise accounts, when this property is set to true
, payment methods are scoped to a specific location.
id string
Unique identifier for this org prefixed with org_
.
logo_url string
The URL for the logo of this organization. We'll use this logo for branding in email communications and shipping labels when permissable.
profile Object
The name, email, address information for this org.
Show Details
requirements Object
Any requirements that are still required for this organization for onboarding. Certain account feature may be impacted if these are not filled out.
Show Details
settings
Settings
These are settings for every API that is used by PackageX. When not provided with defaults, these settings are where default values are pulled from.
Show Details
social_media Object
These are URLs to your social media accounts which we can use for email templates for customer communications.
Show Details
tenants Array.<String>
A list of all organizations for which this organization is financially responsible. All organizations in this list will inherit the pricing information this organization.
updated_at integer
Time in epoch seconds when this organization was last updated.
Billing Model
object "billing"
The description of the model.
collect_automatically boolean
If the invoice will be collected automatically using the default payment information on file.
credits integer
The value in cents of the amount of credits given to this account. Credits will be deducted first from invoices before billing payment methods.
delinquent boolean
If this account is late on payments. This is typically resolved by reaching out to customer support.
discounts Array.<BillingDiscount>
The discounts applied to this account. This is typically applicable for enterprise plans with large volume commitments.
Show Details
downgraded_plan string
The plan to which this organization will be downgraded at the end of the billing cycle, if a downgrade was requested.
fees Array.<BillingFee>
Any one-time fees that will be charged at the next billing cycle.
Show Details
interval string
The frequency when this organization's billing cycle runs. Options include "month", "quarter", "year". We'll always bill on the 1st of the month of the billing cycle, so your first period will typically be prorated.
managing_organization_id string
If this billing account is managed by a different organization.
misc_counts Object
Counts for miscellaneous billable items. Check the misc_prices
property for how much each of these values are billed for.
Show Details
misc_prices Object
Prices for the misc_counts
properties in cents
Show 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. So if your next billable month is June, you will be billed on June 1st.
payment_method string|null
The ID of the payment method used to collect invoices if collect_automatically
is set to true
.
payment_processing Object
The payment processing fees that are charged when a payment has to go through a payment processing network. This typically includes using credit cards as payment methods when reloading a wallet, purchasing a shipping label, or paying an invoice.
Show Details
payment_terms string
After the invoice is generated on the 1st of the billable month, how long until the invoice should be paid. Typically, when collect_automatically
is enabled, this value is set to null
. You may have other options enabled here if you have an enterprise plan.
plan string
This denotes the plan that this organization is on. Options include "starter", "professional", and "enterprise".
price integer
This is the base price of your plan in cents. This does not include any discounts or fees.
prorated_at Integer
On a new organization, this is the time in epoch seconds when the organization signed up and when the start of the billing cycle is.
task_counts Object
These are the counts for the billable tasks accrued during the billing cycle. Check the task_prices
property for how much each of these values are billed for.
Show Details
task_prices Object
The prices for the task_counts
properties in cents.
Show Details
tax_percent float
The amount of tax that will be charged on the invoice. This is a percentage of the total invoice amount.
Settings Model
The settings models are used for default values for many APIs. Typically, every setting here can be overridden on a per-request basis. Settings are nested on the organization model.
For example, to get settings for deliveries
you would find it here: organization.settings.deliveries
settings.deliveries
lead_time_mins integer
The number of minutes it takes for this organization to pickup a delivery. This is used if this organization is a public courier on the PackageX marketplace.
marketplace Object
This property is used if this organization is a public courier on the PackageX marketplace.
Show Details
notification_emails Array.<String>
DEPRECATED
The emails that will be notified when a delivery is created for this organization.
pickup_types Array.<pickup_types>
The global pickup types that are available for this organization's deliveries. You further scope pickup types on a per location basis.
private_rates Array.<PrivateRates>
A list of all private rates create by this organization. Private rates are shown to only this organization when getting generating shipping rates and allow this organization to act as the shipping provider for a delivery. This should be set up if the organization wanted to provide in store pickup and curbside pickup shipping options.
receiving Object
In a typical workflow, you may use the scans API to ingest a shipping label and then create your own internal delivery for the package. This was you can provide tracking updates and notifications to your customers. These settings describe how to handle the receiving of packages and transform them into deliveries.