> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# moonclerk

> MoonClerk Payments

**Server path:** `/moonclerk` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                    | Description                                                                                                                                                        |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`moonclerk_get_customer`](#moonclerk_get_customer)     | Get a specific customer (plan) by ID from MoonClerk. Returns detailed information including subscription status, amount, and associated form.                      |
| [`moonclerk_get_form`](#moonclerk_get_form)             | Get a specific payment form by ID from MoonClerk. Returns form details including title, description, currency, and configuration.                                  |
| [`moonclerk_get_payment`](#moonclerk_get_payment)       | Get a specific payment by ID from MoonClerk. Returns detailed payment information including amount (in cents), currency, status, and associated customer and form. |
| [`moonclerk_list_customers`](#moonclerk_list_customers) | List all customers (plans) in your MoonClerk account. Supports pagination with count and offset parameters.                                                        |
| [`moonclerk_list_forms`](#moonclerk_list_forms)         | List all payment forms in your MoonClerk account. Payment forms are the checkout pages used to collect payments from customers.                                    |
| [`moonclerk_list_payments`](#moonclerk_list_payments)   | List all payments in your MoonClerk account. Supports filtering by form, customer, date range, and status. Money amounts are in cents.                             |

***

## moonclerk\_get\_customer

Get a specific customer (plan) by ID from MoonClerk. Returns detailed information including subscription status, amount, and associated form.

**Parameters:**

| Parameter     | Type    | Required | Default | Description                        |
| ------------- | ------- | -------- | ------- | ---------------------------------- |
| `customer_id` | integer | Yes      | —       | The ID of the customer to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "customer_id": {
        "type": "integer",
        "description": "The ID of the customer to retrieve"
      }
    },
    "required": [
      "PCID",
      "customer_id"
    ]
  }
  ```
</Expandable>

***

## moonclerk\_get\_form

Get a specific payment form by ID from MoonClerk. Returns form details including title, description, currency, and configuration.

**Parameters:**

| Parameter | Type    | Required | Default | Description                            |
| --------- | ------- | -------- | ------- | -------------------------------------- |
| `form_id` | integer | Yes      | —       | The ID of the payment form to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "form_id": {
        "type": "integer",
        "description": "The ID of the payment form to retrieve"
      }
    },
    "required": [
      "PCID",
      "form_id"
    ]
  }
  ```
</Expandable>

***

## moonclerk\_get\_payment

Get a specific payment by ID from MoonClerk. Returns detailed payment information including amount (in cents), currency, status, and associated customer and form.

**Parameters:**

| Parameter    | Type    | Required | Default | Description                       |
| ------------ | ------- | -------- | ------- | --------------------------------- |
| `payment_id` | integer | Yes      | —       | The ID of the payment to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "payment_id": {
        "type": "integer",
        "description": "The ID of the payment to retrieve"
      }
    },
    "required": [
      "PCID",
      "payment_id"
    ]
  }
  ```
</Expandable>

***

## moonclerk\_list\_customers

List all customers (plans) in your MoonClerk account. Supports pagination with count and offset parameters.

**Parameters:**

| Parameter           | Type    | Required | Default | Description                                                                          |
| ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `count`             | integer | No       | —       | Number of results to return (1-100, default 10)                                      |
| `offset`            | integer | No       | —       | Number of results to skip for pagination                                             |
| `form_id`           | integer | No       | —       | Filter customers by payment form ID                                                  |
| `checkout_from`     | string  | No       | —       | Filter customers with checkout date on or after this date (ISO 8601 UTC format)      |
| `checkout_to`       | string  | No       | —       | Filter customers with checkout date on or before this date (ISO 8601 UTC format)     |
| `next_payment_from` | string  | No       | —       | Filter customers with next payment date on or after this date (ISO 8601 UTC format)  |
| `next_payment_to`   | string  | No       | —       | Filter customers with next payment date on or before this date (ISO 8601 UTC format) |
| `status`            | string  | No       | —       | Filter by subscription status (active, suspended, canceled, expired)                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "count": {
        "type": "integer",
        "description": "Number of results to return (1-100, default 10)"
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip for pagination"
      },
      "form_id": {
        "type": "integer",
        "description": "Filter customers by payment form ID"
      },
      "checkout_from": {
        "type": "string",
        "description": "Filter customers with checkout date on or after this date (ISO 8601 UTC format)"
      },
      "checkout_to": {
        "type": "string",
        "description": "Filter customers with checkout date on or before this date (ISO 8601 UTC format)"
      },
      "next_payment_from": {
        "type": "string",
        "description": "Filter customers with next payment date on or after this date (ISO 8601 UTC format)"
      },
      "next_payment_to": {
        "type": "string",
        "description": "Filter customers with next payment date on or before this date (ISO 8601 UTC format)"
      },
      "status": {
        "type": "string",
        "description": "Filter by subscription status (active, suspended, canceled, expired)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## moonclerk\_list\_forms

List all payment forms in your MoonClerk account. Payment forms are the checkout pages used to collect payments from customers.

**Parameters:**

| Parameter | Type    | Required | Default | Description                                     |
| --------- | ------- | -------- | ------- | ----------------------------------------------- |
| `count`   | integer | No       | —       | Number of results to return (1-100, default 10) |
| `offset`  | integer | No       | —       | Number of results to skip for pagination        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "count": {
        "type": "integer",
        "description": "Number of results to return (1-100, default 10)"
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip for pagination"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## moonclerk\_list\_payments

List all payments in your MoonClerk account. Supports filtering by form, customer, date range, and status. Money amounts are in cents.

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                  |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `count`       | integer | No       | —       | Number of results to return (1-100, default 10)              |
| `offset`      | integer | No       | —       | Number of results to skip for pagination                     |
| `form_id`     | integer | No       | —       | Filter payments by payment form ID                           |
| `customer_id` | integer | No       | —       | Filter payments by customer ID                               |
| `date_from`   | string  | No       | —       | Filter payments on or after this date (ISO 8601 UTC format)  |
| `date_to`     | string  | No       | —       | Filter payments on or before this date (ISO 8601 UTC format) |
| `status`      | string  | No       | —       | Filter by payment status (successful, refunded, pending)     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "count": {
        "type": "integer",
        "description": "Number of results to return (1-100, default 10)"
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip for pagination"
      },
      "form_id": {
        "type": "integer",
        "description": "Filter payments by payment form ID"
      },
      "customer_id": {
        "type": "integer",
        "description": "Filter payments by customer ID"
      },
      "date_from": {
        "type": "string",
        "description": "Filter payments on or after this date (ISO 8601 UTC format)"
      },
      "date_to": {
        "type": "string",
        "description": "Filter payments on or before this date (ISO 8601 UTC format)"
      },
      "status": {
        "type": "string",
        "description": "Filter by payment status (successful, refunded, pending)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>