Customers

List customers

Returns customers and their subscription info. These are the records the MoonClerk web interface calls "Plans". Filters may be combined; all date filters are YYYY-MM-DD and UTC-based, with *_from starting at the beginning of the day and *_to running through the end of it.

get/customers

Request

  • Base URL: https://api.moonclerk.com
  • URL: https://api.moonclerk.com/customers
  • Auth: API key in header Authorization

Query parameters

countinteger

Number of rows to return.

offsetinteger

Starting position of the result set.

form_idinteger

The associated MoonClerk form ID.

checkout_fromstring date

Customers created on or after this date.

checkout_tostring date

Customers created on or before this date.

next_payment_fromstring date

Subscription due to bill on or after this date.

next_payment_tostring date

Subscription due to bill on or before this date.

status'active' | 'canceled' | 'expired' | 'past_due' | 'pending' | 'unpaid'

Subscription status.

Response

A page of customers.

Changes

No recorded changes to this operation across all 1 revision of this API.