NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Moonclerk connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Moonclerk actions, such as "List Customers", "List Discounts" and "List Payment Forms". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Moonclerk, with input parameters and output schema.
MOONCLERK_LIST_CUSTOMERSTool to list customers (plans) from MoonClerk. Use when you need to retrieve customer data with optional filters. Use after authenticating API credentials.
Input parameters
Filter by subscription status.
The associated MoonClerk form ID to filter customers.
Customers created on or before this date (YYYY-MM-DD).
Customers created on or after this date (YYYY-MM-DD).
Subscriptions due to bill on or before this date (YYYY-MM-DD).
Subscriptions due to bill on or after this date (YYYY-MM-DD).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOONCLERK_LIST_DISCOUNTSTool to retrieve a list of all discounts applied to customers. Use after authenticating API credentials.
Input parameters
Filter by subscription status.
Filter discounts by associated MoonClerk form ID.
Filter customers created on or before this date (YYYY-MM-DD).
Filter customers created on or after this date (YYYY-MM-DD).
Filter subscriptions due to bill on or before this date (YYYY-MM-DD).
Filter subscriptions due to bill on or after this date (YYYY-MM-DD).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOONCLERK_LIST_FORMSTool to retrieve a list of all payment forms. Use after authenticating to inspect available payment forms.
Input parameters
Page number to retrieve, starting at 1
Number of forms per page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOONCLERK_LIST_PAYMENTSTool to list payments. Use when you need to retrieve all payments or filter by form, customer, date range, or status after authenticating.
Input parameters
Filter payments by status. Valid values: successful, refunded, failed
Include payments charged on or before this date (YYYY-MM-DD)
MoonClerk form ID to filter payments (e.g., 5346)
Include payments charged on or after this date (YYYY-MM-DD)
MoonClerk customer ID to filter payments (e.g., 12742)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOONCLERK_LIST_SUBSCRIPTIONSTool to list subscriptions. Use when you need to retrieve all subscriptions after authenticating.
Input parameters
Filter subscriptions by status. Valid options: active, canceled, expired, past_due, pending, unpaid
Filter subscriptions by the associated MoonClerk form ID (e.g., 5346)
Include subscriptions due to bill on or before this date (YYYY-MM-DD)
Include subscriptions due to bill on or after this date (YYYY-MM-DD)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 Moonclerk actions on Nagent, including "List Customers", "List Discounts" and "List Payment Forms". List Customers: List customers (plans) from MoonClerk. Each action is listed on this page with its input parameters and its output.
Moonclerk connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It also takes 6 optional inputs: status, form_id, checkout_to, checkout_from, next_payment_to and next_payment_from. It returns data, error and successful.