documentCapture.getRemainingFreeUsage()

Note:

The content in this help topic pertains to SuiteScript 2.1.

Method Description

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.

Returns

number

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
...

const usage = documentCapture.getRemainingFreeUsage();

...
// Add additional code

Syntax

Related Topics