# Moonclerk

MoonClerk is a platform that enables businesses to accept recurring and one-time online payments.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `MOONCLERK`
- **Version:** 20260227_00

## Tools

### List Customers

**Slug:** `MOONCLERK_LIST_CUSTOMERS`

Tool to list customers (plans) from MoonClerk. Use when you need to retrieve customer data with optional filters. Use after authenticating API credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "canceled" | "expired" | "past_due" | "pending" | "unpaid") | No | Filter by subscription status. |
| `form_id` | integer | No | The associated MoonClerk form ID to filter customers. |
| `checkout_to` | string | No | Customers created on or before this date (YYYY-MM-DD). |
| `checkout_from` | string | No | Customers created on or after this date (YYYY-MM-DD). |
| `next_payment_to` | string | No | Subscriptions due to bill on or before this date (YYYY-MM-DD). |
| `next_payment_from` | string | No | Subscriptions due to bill on or after this date (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discounts

**Slug:** `MOONCLERK_LIST_DISCOUNTS`

Tool to retrieve a list of all discounts applied to customers. Use after authenticating API credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "canceled" | "expired" | "past_due" | "pending" | "unpaid") | No | Filter by subscription status. |
| `form_id` | integer | No | Filter discounts by associated MoonClerk form ID. |
| `checkout_to` | string | No | Filter customers created on or before this date (YYYY-MM-DD). |
| `checkout_from` | string | No | Filter customers created on or after this date (YYYY-MM-DD). |
| `next_payment_to` | string | No | Filter subscriptions due to bill on or before this date (YYYY-MM-DD). |
| `next_payment_from` | string | No | Filter subscriptions due to bill on or after this date (YYYY-MM-DD). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Forms

**Slug:** `MOONCLERK_LIST_FORMS`

Tool to retrieve a list of all payment forms. Use after authenticating to inspect available payment forms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve, starting at 1 |
| `per_page` | integer | No | Number of forms per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `MOONCLERK_LIST_PAYMENTS`

Tool to list payments. Use when you need to retrieve all payments or filter by form, customer, date range, or status after authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("successful" | "refunded" | "failed") | No | Filter payments by status. Valid values: successful, refunded, failed |
| `date_to` | string | No | Include payments charged on or before this date (YYYY-MM-DD) |
| `form_id` | integer | No | MoonClerk form ID to filter payments (e.g., 5346) |
| `date_from` | string | No | Include payments charged on or after this date (YYYY-MM-DD) |
| `customer_id` | integer | No | MoonClerk customer ID to filter payments (e.g., 12742) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscriptions

**Slug:** `MOONCLERK_LIST_SUBSCRIPTIONS`

Tool to list subscriptions. Use when you need to retrieve all subscriptions after authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "canceled" | "expired" | "past_due" | "pending" | "unpaid") | No | Filter subscriptions by status. Valid options: active, canceled, expired, past_due, pending, unpaid |
| `form_id` | string | No | Filter subscriptions by the associated MoonClerk form ID (e.g., 5346) |
| `next_payment_to` | string | No | Include subscriptions due to bill on or before this date (YYYY-MM-DD) |
| `next_payment_from` | string | No | Include subscriptions due to bill on or after this date (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |