The status of end-users’ QuickBooks Online subscription impacts the way your app can use our API and related operations.
Build your app so it can anticipate subscription status changes and continue to work as expected.
New users can start with a trial or subscribe to QuickBooks Online right away. Many users start with a trial and then subscribe at the end of the trial period.
From a backend perspective, if an end-user’s QuickBooks Online company’s subscription status is “trial” or “subscribed,” your app can use read and write operations.
Users may stop their subscription for various reasons. We may also pause (i.e. restrict or suspend) their subscription due to payment issues. Subscriptions can also expire due to inactivity.
If your end-users’ subscription status is “canceled,” “expired,” “suspended,” or “restricted,” your app is limited to read-only operations.
Users can resubscribe to QuickBooks within certain time frames. If this time elapses, we delete their company data.
Query the CompanyInfo entity using the
SubscriptionStatus attribute to see an end-user’s current subscription status.
Here are the possible subscription statuses for the
The user has a trial version of QuickBooks Online. They have an active, working QuickBooks Online company file.
|TRIALOPTIN||Read/write||The user has a trial version of QuickBooks Online, and they’ve already paid to start their subscription once their trial ends.|
The user’s trial period is over. Unfortunately, they decided not to subscribe to QuickBooks Online.
|SUBSCRIBED||Read/write||The user is fully subscribed to QuickBooks Online.|
The user is subscribed to QuickBooks Online, but a recent payment wasn’t processed.
The user was subscribed and the “restricted” period time elapsed. The user still hasn’t paid for their subscription.
The user canceled their trial or subscription, or it was canceled by our support staff.
|UNKNOWN||N/A||Context of the company is not available.|