Skip to content

A customer's lifetime value, what it owes and its monthly revenue

GET
/products/{productId}/insights/customer
curl --request GET \
--url https://api.motenya.app/v1/products/example/insights/customer \
--header 'Authorization: Bearer <token>'

Pass contactId or clientId.

Requires crm:read.

productId
required
string
>= 1 characters <= 64 characters
contactId
string
>= 1 characters <= 64 characters
clientId

Pass contactId or clientId.

string
>= 1 characters <= 64 characters

Pass contactId or clientId.

months

Months of history, 1–36 (default 12).

integer
>= 1 <= 36

Months of history, 1–36 (default 12).

Success

Media typeapplication/json

Per currency, never converted. Paid means not canceled or refunded, and paid or with no payment status.

object
lifetimeValue
required
Array<object>
object
currency
required
string
amount
required
string
outstanding
required

Unpaid or partly paid, counted in full.

Array<object>
object
currency
required
string
amount
required
string
overdue
required
Array<object>
object
currency
required
string
amount
required
string
orderCount
required
integer
firstOrderAt
required
string | null
lastOrderAt
required
string | null
mrr
required

Monthly recurring revenue of its active and past-due subscriptions.

Array<object>
object
currency
required
string
amount
required
string
monthly
required

Paid per month, oldest first; empty months are zero.

Array<object>
object
month
required

“YYYY-MM”, UTC.

string
currency
required
string
amount
required
string
key
additional properties

Example generated

{
"lifetimeValue": [
{
"currency": "example",
"amount": "example"
}
],
"outstanding": [
{
"currency": "example",
"amount": "example"
}
],
"overdue": [
{
"currency": "example",
"amount": "example"
}
],
"orderCount": 1,
"firstOrderAt": "example",
"lastOrderAt": "example",
"mrr": [
{
"currency": "example",
"amount": "example"
}
],
"monthly": [
{
"month": "example",
"currency": "example",
"amount": "example"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error