Moonclerk
moonclerkMoonClerk is a platform that enables businesses to accept recurring and one-time online payments.
Acciones disponibles (5)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
List CustomersMOONCLERK_LIST_CUSTOMERSAcciónTool to list customers (plans) from moonclerk. use when you need to retrieve customer data with optional filters. use after authenticating api credentials.
MOONCLERK_LIST_CUSTOMERSAcciónTool to list customers (plans) from moonclerk. use when you need to retrieve customer data with optional filters. use after authenticating api credentials.
Parámetros de entrada
statusstringenumFilter by subscription status.
activecanceledexpiredpast_duependingunpaidform_idintegerThe associated MoonClerk form ID to filter customers.
checkout_tostringCustomers created on or before this date (YYYY-MM-DD).
checkout_fromstringCustomers created on or after this date (YYYY-MM-DD).
next_payment_tostringSubscriptions due to bill on or before this date (YYYY-MM-DD).
next_payment_fromstringSubscriptions due to bill on or after this date (YYYY-MM-DD).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DiscountsMOONCLERK_LIST_DISCOUNTSAcciónTool to retrieve a list of all discounts applied to customers. use after authenticating api credentials.
MOONCLERK_LIST_DISCOUNTSAcciónTool to retrieve a list of all discounts applied to customers. use after authenticating api credentials.
Parámetros de entrada
statusstringenumFilter by subscription status.
activecanceledexpiredpast_duependingunpaidform_idintegerFilter discounts by associated MoonClerk form ID.
checkout_tostringFilter customers created on or before this date (YYYY-MM-DD).
checkout_fromstringFilter customers created on or after this date (YYYY-MM-DD).
next_payment_tostringFilter subscriptions due to bill on or before this date (YYYY-MM-DD).
next_payment_fromstringFilter subscriptions due to bill on or after this date (YYYY-MM-DD).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment FormsMOONCLERK_LIST_FORMSAcciónTool to retrieve a list of all payment forms. use after authenticating to inspect available payment forms.
MOONCLERK_LIST_FORMSAcciónTool to retrieve a list of all payment forms. use after authenticating to inspect available payment forms.
Parámetros de entrada
pageintegerPage number to retrieve, starting at 1
per_pageintegerNumber of forms per page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsMOONCLERK_LIST_PAYMENTSAcciónTool to list payments. use when you need to retrieve all payments or filter by form, customer, date range, or status after authenticating.
MOONCLERK_LIST_PAYMENTSAcciónTool to list payments. use when you need to retrieve all payments or filter by form, customer, date range, or status after authenticating.
Parámetros de entrada
statusstringenumFilter payments by status. Valid values: successful, refunded, failed
successfulrefundedfaileddate_tostringInclude payments charged on or before this date (YYYY-MM-DD)
form_idintegerMoonClerk form ID to filter payments (e.g., 5346)
date_fromstringInclude payments charged on or after this date (YYYY-MM-DD)
customer_idintegerMoonClerk customer ID to filter payments (e.g., 12742)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubscriptionsMOONCLERK_LIST_SUBSCRIPTIONSAcciónTool to list subscriptions. use when you need to retrieve all subscriptions after authenticating.
MOONCLERK_LIST_SUBSCRIPTIONSAcciónTool to list subscriptions. use when you need to retrieve all subscriptions after authenticating.
Parámetros de entrada
statusstringenumFilter subscriptions by status. Valid options: active, canceled, expired, past_due, pending, unpaid
activecanceledexpiredpast_duependingunpaidform_idstringFilter subscriptions by the associated MoonClerk form ID (e.g., 5346)
next_payment_tostringInclude subscriptions due to bill on or before this date (YYYY-MM-DD)
next_payment_fromstringInclude subscriptions due to bill on or after this date (YYYY-MM-DD)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not