Links

Account settings

Account info & settings

In your dashboard, access your Settings in the dropdown menu at the top right corner of your screen to view your account details or configure your settings. Note that you must be on certain platform editions or have admin access levels to be able to view or update certain tabs or settings.
You can find the following information in each tab.
Account tab
User tab
API Keys tab
Payment tab [admin only]
Editions tab
Invoices tab
Logs tab [admin only]
Reporting tab [admin only]

Changing your account

Upgrading API versions

When backward-incompatible changes are made to the API, a new dated version is released. You can view your version and upgrade to the latest version in your dashboard under the API Keys tab.
We highly recommend upgrading to the latest API version. Upgrading allows you to keep up to date the with the latest features, bug fixes, and performance improvements.
To test a newer version of the API, you need to specify a version in the HTTP header as shown in the API documentation. The API will return an error if a version older than your current one is passed in.
Update: Any API version prior to 2020-02-11 has been sunsetted.

Upgrading or downgrading subscriptions

In the Editions tab in your Lob dashboard, go to the desired subscription (Print & Mail, Address Verification, or Support) you'd like to upgrade/downgrade in the toggle bar. Under the Available Plans section, change to your desired edition. If you are already subscribed to an Enterprise edition, speak with your Customer Success Manager if you'd like to discuss your subscription.
If you purchase an edition and start it immediately, you will gain access to the upgraded edition’s features and limits immediately. If you purchase an edition and choose for it to start on the 1st of the next month, you will gain access to upgraded edition’s features and limits on the first day of the following calendar month.
If you decide to upgrade to a higher edition during the month, we prorate the price difference between your original and new plan. At the end of your first month, your plan will continue to renew at the start of each subsequent month for the full amount.
If you upgrade to an annual plan from your original monthly plan in the middle of the month, you will be charged upfront for 11 months worth of subscription fees plus a prorated charge for the current month. The current month will count as the first month of your subscription.
If you downgrade to a lower edition during the month, you will retain the features of your current edition through the end of the current calendar month. Lob will snapshot your account’s settings as they currently are and allow you to continue using any existing templates/webhooks/settings created or set prior to the downgrade. Once the new lower-tiered edition takes effect at the start of the next billing cycle (e.g. start of next calendar month), you will no longer be able to add/adjust the lost features.
Usage counts for mailing volumes are applied based on calendar months and will reset on the first day of each month at 12:00AM UTC.

Closing or deleting your account

If you would like to close your account, you can reach out to [email protected] with your Account ID and reason for closing the account. You may locate your Account ID in the Account tab of your dashboard. Deletions will only be processed if all outstanding invoices have been paid and there is no unbilled usage for the current billing period.
Alternatively, you may opt to downgrade to the Developer edition ($0 monthly subscription fee) and still keep your account with Lob open. This will allow you to return to Lob at any time in the future while ensuring that you do not get charged a platform fee. Downgrading only applies to accounts under a paying subscription (Startup, Growth, etc).

Account bans/suspensions

As part of our security measures, we regularly screen activity on our platform. If an account is flagged for suspicious activity, it will be suspended. If you would like to appeal the suspension you can contact [email protected], who will ask you for supporting documentation, and we will work with our Security team in an attempt to verify the integrity of the account.

Account-level data logs

Webhooks

Webhooks are an easy way to get notifications on events happening asynchronously within Lob's architecture. You can view, create, and debug webhooks on the Lob dashboard, as well as view subscribed events. Note that in Live mode, you can only have as many non-deleted webhooks as allotted in your current Print & Mail Edition. There is no limit in Test mode.
See our Webhooks integration guide for more details on how to integrate.
See the full list of event types available for subscription in our API documentation.

Audit logs

All actions available through the dashboard's settings panel are recorded in the Logs section, which can be fully accessed by admins in Enterprise-level accounts. Only API logs for the past 30 days are saved as they are meant for simple real-time debugging.
Click on the '+' sign for any user row at the right side of the screen to see more details, or click on the Filter button at the top to narrow your search for specific audit logs, such as:
  • Action
  • Associated user
  • IP address
  • User agent
  • Time stamp (UTC)
Recorded actions

NCOA export

National Change of Address (NCOA) is a service offered by the USPS, which allows individuals or businesses who have recently moved to have any mail forwarded from their previous address to their new address.
As a CASS-certified address verification provider, Lob also offers NCOA functionality to our Print & Mail customers. With the Lob NCOA feature enabled, postcards, self-mailers, letters, checks and addresses can automatically be corrected to reflect an individual's or business' new address in the case that they have moved (only if they have registered an NCOA with the USPS).
For Enterprise edition accounts with NCOA enabled, Lob generates a weekly report of suppressed API response data for addresses that have been changed through NCOA. These reports can be downloaded in the dashboard under the Reporting tab. In order to gain access to and download NCOA'd data, customers must send at least 100 NCOA'd addresses within a single USPS-defined 'week' period.
Read more on the NCOA functionality offered by Lob.

Event logs

Event logs are records of the mail piece events associated to your account's API submissions.
Within the Event logs section use the filter to select a date range, a resource type, and desired event type to generate a list of Reference IDs that apply to the selected criteria.
While it is also possible to go to any resource type (postcards, letters, checks, etc.) in the left menu of the dashboard and export all selected tracking events in a CSV file, the Event Logs section is currently the only place where you can generate tracking events for return envelopes.
See Mail data & tracking for more information.

API logs

API logs are records of your requests, tied to the specific information you provided for the submission.
Use the filter to select a date range, reference ID, path, method, or status code which will generate a list of API logs that apply to the selected criteria. Click on any API log to view more details, including the request post body and response body.
If you are looking for more context behind any error codes you have received, check the response body in the API logs for detailed error messages. You can also see the full list of error messages in our API documentation.
We only save API logs for the preceding 30 days, as they are meant for simple real-time debugging.