NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

Billing → Retrieves an agreement given its ID.

AI-generated

Summary

Retrieve a billing agreement by its unique Agreement ID, optionally customizing the request with additional body content, headers, query filters, batching, debugging, pagination, and timeout settings.

Inputs

  • id (required) — Numeric Agreement ID to retrieve the specific billing agreement.
  • options — Optional settings including custom JSON body, custom HTTP headers, query-string filters, batching configuration to control request grouping and intervals, debug mode to include request details in output, pagination handling (though for this single resource retrieval it's likely unused), and request timeout in milliseconds.

Output shape

a single record representing the billing agreement identified by the given ID, including any API response properties that describe the agreement

The output may include debug details if debug option is enabled. Pagination options are available but unlikely to affect this operation since it retrieves a single agreement by ID. Custom body fields provided via options are deep-merged with standard parameters for the request. Batch settings determine request grouping when processing multiple input items.

Examples

Example 1: Retrieve agreement with ID 12345

Set 'id' to 12345; optionally add custom headers or query filters as needed.

Links

Discussion