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


Object.address `Address` The address for this organization
Object.dba_name `string` Optional property for the preferred name to use in customer communications
Object.email `string` The main email for the organization
Object.name `string` The legal name for the organization
Object.phone `string` The phone number of the org. We'll use this number to contact you if there are any issues with your account.
Object.website `string` The website for the organization

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


Object.errors `Array.<String>` A list of errors that needs to be fixed on the account.
Object.pending_verification `Array.<String>` A list of items that are being verified.
Object.required_now `Array.<String>` A list of action items that need to be finished now for successful onboarding.

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


Object.address `Address` The address for this organization
Object.dba_name `string` Optional property for the preferred name to use in customer communications
Object.email `string` The main email for the organization
Object.name `string` The legal name for the organization
Object.phone `string` The phone number of the org. We'll use this number to contact you if there are any issues with your account.
Object.website `string` The website for the organization

social_media Object
These are URLs to your social media accounts which we can use for email templates for customer communications.

Show Details


Object.facebook `string`
Object.instagram `string`
Object.linkedin `string`
Object.tiktok `string`
Object.twitter `string`
Object.youtube `string`

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


BillingDiscount.name `String` The name of the discount
BillingDiscount.percent `float` The percent this discount will reduce
BillingDiscount.max_amount `integer` The maximum amount this discount will reduce in cents.
BillingDiscount.order `integer` The order this discount will be applied in if there are multiple

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


BillingFee.name `String` The name of the discount
BillingFee.amount `integer` The amount that will be charged in cents
BillingFee.invoice_id `string` The invoice to which this fee was applied
BillingFee.is_taxable `boolean` If tax should be collected on this fee

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


Object.locations `integer` The number of locations you have.
Object.text_messages `integer` The number of text messages we have sent on your behalf.
Object.tenants `string` The amount of organizations that are sharing this org's billing account.

misc_prices Object
Prices for the misc_counts properties in cents

Show Details


Object.locations `integer` Price per location
Object.text_messages `integer` Price per text messages sent
Object.tenants `string` Price per tenant

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


Object.amount `integer` The amount in cents that is charged for the transaction.
Object.percent `float` The percent of the transaction billed amount that will be added to the total.

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


Object.assets `integer` The number of unique asset IDs that were created.
Object.containers `integer` The number of containers that were created.
Object.fulfillments `string` The number of fulfillments that were created.
Object.items `string` The number of unique SKUs that were added.
Object.manifests `string` The number of manifests that were accepted.
Object.routes `string` The number of routes that were calculated.
Object.scans `string` The number of OCR scans that were processed.
Object.shipments `string` The amount of shipping rates pulled that included third party providers.
Object.trackers `string` The number of external tracking requests.

task_prices Object
The prices for the task_counts properties in cents.

Show Details


Object.assets `integer`
Object.containers `integer`
Object.fulfillments `string`
Object.items `string`
Object.manifests `string`
Object.routes `string`
Object.scans `string`
Object.shipments `string`
Object.trackers `string`

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.

chained_status TrackingStatusOutstanding
The status of chain

`settings.defaults`

settings.defaults.shipments_easy_post_api_key String
Your easy post API key. Add test key for test environment and Production key for production.

settings.defaults.shipments_ups_carrier_account_id String
UPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

settings.defaults.shipments_usps_carrier_account_id String
USPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

settings.defaults.shipments_fedex_carrier_account_id String
FedEx Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

settings.defaults.shipments_dhl_carrier_account_id String
DHL Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

`settings?.trackers?.defaults?.chained_status`

`settings.defaults`

settings.defaults.shipments_easy_post_api_key String
Your easy post API key. Add test key for test environment and Production key for production.

settings.defaults.shipments_ups_carrier_account_id String
UPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

settings.defaults.shipments_usps_carrier_account_id String
USPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

settings.defaults.shipments_fedex_carrier_account_id String
FedEx Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

        enum TrackingStatusOutstanding {
  provider_at_pickup
  package_accepted
  out_for_delivery
  provider_at_dropoff
  scheduled
  driver_dispatched
  package_at_waypoint
  in_transit
  pickup_available
  recipient_at_pickup
  added_to_container
  removed_from_container
  added_to_vehicle
  removed_from_vehicle
  delivered_to_provider
}

auto_close_shipments_option TrackerCloseShipmentsOption

`settings?.trackers?.defaults?.auto_close_shipments_option`

This option determines how to handle outstanding shipments: on_provider_updates: Outstanding shipments will be closed only when the provider sends a tracking update to the shipment. on_all_updates: Outstanding shipments will be closed on any tracking update to the shipment. off: Outstanding shipments will be ignored.

Default: on_provider_updates

        enum TrackerCloseShipmentsOption {
  on_provider_updates
  on_all_updates
  off
}

auto_close_shipments_status TrackerCloseShipmentsStatus

`settings?.trackers?.defaults?.auto_close_shipments_status`

When on_all_updates or on_provider_updates is active, you can select the following completed non-exception statuses for outstanding shipments:

        enum TrackerCloseShipmentsStatus {
  delivered
  picked_up
}

chained_status TrackingStatusOutstanding
The status of chain

`settings?.trackers?.defaults?.chained_status`

        enum TrackingStatusOutstanding {
  provider_at_pickup
  package_accepted
  out_for_delivery
  provider_at_dropoff
  scheduled
  driver_dispatched
  package_at_waypoint
  in_transit
  pickup_available
  recipient_at_pickup
  added_to_container
  removed_from_container
  added_to_vehicle
  removed_from_vehicle
  delivered_to_provider
}

auto_close_shipments_option TrackerCloseShipmentsOption

`settings?.trackers?.defaults?.auto_close_shipments_option`

Default: on_provider_updates

        enum TrackerCloseShipmentsOption {
  on_provider_updates
  on_all_updates
  off
}

auto_close_shipments_status TrackerCloseShipmentsStatus

`settings?.trackers?.defaults?.auto_close_shipments_status`

When on_all_updates or on_provider_updates is active, you can select the following completed non-exception statuses for outstanding shipments:

        enum TrackerCloseShipmentsStatus {
  delivered
  picked_up
}

`settings?.events?.expire_after`

Show Details


Object.application_status `String` The status of the marketplace application. Values include "applied", "inactive", "approved", and "rejected"
Object.rating `float` The current rating this organization has on the PackageX marketplace. Ratings are determined by many factors and more recent deliveries impact the rating more than older ones.

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.

Show Details


Object.default_parcel `Object` Sometimes there are no dimensions on the shipping label so we can use a default parcel to create a delivery with "average" dimensions and weight.
Object.default_parcel.height `number` The default height in inches of the average package this organization receives.
Object.default_parcel.length `number` The default length in inches of the average package this organization receives.
Object.default_parcel.width `number` The default width in inches of the average package this organization receives.
Object.default_parcel.weight `number` The default weight in lbs of the average package this organization receives.
Object.default_status `shipment_status` The status you want the delivery to have when it's created via a scan.
Object.label `Object` Details about the shipping label that we should generate for this delivery.
Object.label.size `String` The size of the shipping label that will be generated.

Model

# Organization Model

# Billing Model

# Settings Model

# settings.deliveries

# settings.defaults

# settings?.trackers?.defaults?.chained_status

# settings.defaults

# settings?.trackers?.defaults?.auto_close_shipments_option

# settings?.trackers?.defaults?.auto_close_shipments_status

# settings?.trackers?.defaults?.chained_status

# settings?.trackers?.defaults?.auto_close_shipments_option

# settings?.trackers?.defaults?.auto_close_shipments_status

# settings?.events?.expire_after

On this page

Organization Model

Billing Model

Settings Model

`settings.deliveries`

`settings.defaults`

`settings?.trackers?.defaults?.chained_status`

`settings.defaults`

`settings?.trackers?.defaults?.auto_close_shipments_option`

`settings?.trackers?.defaults?.auto_close_shipments_status`

`settings?.trackers?.defaults?.chained_status`

`settings?.trackers?.defaults?.auto_close_shipments_option`

`settings?.trackers?.defaults?.auto_close_shipments_status`

`settings?.events?.expire_after`