1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/documentCapture Module
  6. documentCapture.getRemainingFreeUsage.promise()

documentCapture.getRemainingFreeUsage.promise()

Note:

The content in this help topic pertains to SuiteScript 2.1.

Method Description

Asynchronously returns the number of free document capture requests remaining for the current month.

This method tracks usage for the documentCapture.documentToStructure(options) method. The documentCapture.documentToText(options) method doesn't consume usage from the free usage pool. You can track your current monthly usage on the AI Preferences page in NetSuite. For more information, see View SuiteScript AI Usage Limit and Usage.

Note:

The parameters and errors thrown for this method are the same as those for documentCapture.getRemainingFreeUsage(). For more information about promises, see Promise Object.

Returns

Promise Object

Synchronous Version

documentCapture.getRemainingFreeUsage()

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/documentCapture Module

Since

2025.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/documentCapture Module Script Samples.

            // Add additional code
...

documentCapture.getRemainingFreeUsage.promise().then(function(result) {
    // Work with the result
});

...
// Add additional code

Related Topics

General Notices