Skip to content

The ticket's customer: contact, clients, orders and subscriptions

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

What agents see beside a ticket, from the CRM of its product, including orders whose numbers the customer quoted.

Requires tickets:read.

productId
required
string
>= 1 characters <= 64 characters
id
required
string
>= 1 characters <= 64 characters

Success

Media typeapplication/json
object
email
required
string | null
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
emails
required
Array<string>
phone
required
string | null
language
required
string | null
tags
required
Array<string>
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
clients
required
Array<object>
object
clientId
required
string
>= 1 characters <= 64 characters
name
required
string
kind
required
string
Allowed values: company individual
role
required
string | null
createdAt
required
string
updatedAt
required
string
clients
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
name
required
string
kind
required
string
Allowed values: company individual
vatNumber
required
string | null
registrationNumber
required
string | null
addresses
required
Array<object>
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
tags
required
Array<string>
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
contacts
required
Array<object>
object
contactId
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
role
required
string | null
createdAt
required
string
updatedAt
required
string
key
additional properties
orderCount
required
integer
lifetimeTotals
required
Array<object>
object
currency
required
string
amount
required
string
recentOrders
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
storeId
required

Null only for a subscription’s invoice.

string | null
>= 1 characters <= 64 characters
storeName
required
string | null
number
required
string
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
client
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
subscription
required
object
id
required
string
>= 1 characters <= 64 characters
planName
required
string
periodStart
required
string | null
periodEnd
required
string | null
status
required
string
Allowed values: pending processing on_hold shipped completed canceled refunded
statusRaw
required
string | null
paymentStatus
required
string | null
Allowed values: unpaid partially_paid paid refunded void
paidAt
required
string | null
dueAt
required
string | null
overdue
required
boolean
currency
required
string
subtotal
required
string | null
shipping
required
string | null
tax
required
string | null
discount
required
string | null
total
required
string
paymentMethod
required
string | null
billingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
shippingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
placedAt
required
string
items
required
Array<object>
object
catalogItemId
required
string | null
>= 1 characters <= 64 characters
sku
required
string | null
name
required
string
quantity
required
number
unitPrice
required
string
rowTotal
required
string
options
required
Array<object>
object
label
required
string
value
required
string
shipments
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
carrierCode
required
string | null
carrierName
required
string | null
trackingNumber
required
string | null
state
required
string
Allowed values: pending in_transit delivered returned canceled
deliveredAt
required
string | null
key
additional properties
documents
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kind
required
string
Allowed values: invoice credit_memo
number
required
string | null
amount
required
string
reason
required
string | null
issuedAt
required
string
key
additional properties
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
key
additional properties
pinnedOrders
required
Array<object>
object
order
required
object
id
required
string
>= 1 characters <= 64 characters
storeId
required

Null only for a subscription’s invoice.

string | null
>= 1 characters <= 64 characters
storeName
required
string | null
number
required
string
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
client
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
subscription
required
object
id
required
string
>= 1 characters <= 64 characters
planName
required
string
periodStart
required
string | null
periodEnd
required
string | null
status
required
string
Allowed values: pending processing on_hold shipped completed canceled refunded
statusRaw
required
string | null
paymentStatus
required
string | null
Allowed values: unpaid partially_paid paid refunded void
paidAt
required
string | null
dueAt
required
string | null
overdue
required
boolean
currency
required
string
subtotal
required
string | null
shipping
required
string | null
tax
required
string | null
discount
required
string | null
total
required
string
paymentMethod
required
string | null
billingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
shippingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
placedAt
required
string
items
required
Array<object>
object
catalogItemId
required
string | null
>= 1 characters <= 64 characters
sku
required
string | null
name
required
string
quantity
required
number
unitPrice
required
string
rowTotal
required
string
options
required
Array<object>
object
label
required
string
value
required
string
shipments
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
carrierCode
required
string | null
carrierName
required
string | null
trackingNumber
required
string | null
state
required
string
Allowed values: pending in_transit delivered returned canceled
deliveredAt
required
string | null
key
additional properties
documents
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kind
required
string
Allowed values: invoice credit_memo
number
required
string | null
amount
required
string
reason
required
string | null
issuedAt
required
string
key
additional properties
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
key
additional properties
linked
required
boolean
ownOrder
required
boolean
subscriptions
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
client
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
catalogItemId
required
string | null
>= 1 characters <= 64 characters
storeId
required
string | null
>= 1 characters <= 64 characters
planName
required
string
status
required
string
Allowed values: trialing active past_due paused canceled
amount
required
string
currency
required
string
interval
required
string
Allowed values: day week month year
intervalCount
required
integer
monthlyAmount
required

Amount per month, for MRR.

string
seats
required
integer | null
startedAt
required
string
trialEndsAt
required
string | null
currentPeriodEnd
required
string | null
canceledAt
required
string | null
endsAt
required
string | null
ended
required
boolean
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
key
additional properties
endedSubscription
required
object
id
required
string
>= 1 characters <= 64 characters
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
client
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
catalogItemId
required
string | null
>= 1 characters <= 64 characters
storeId
required
string | null
>= 1 characters <= 64 characters
planName
required
string
status
required
string
Allowed values: trialing active past_due paused canceled
amount
required
string
currency
required
string
interval
required
string
Allowed values: day week month year
intervalCount
required
integer
monthlyAmount
required

Amount per month, for MRR.

string
seats
required
integer | null
startedAt
required
string
trialEndsAt
required
string | null
currentPeriodEnd
required
string | null
canceledAt
required
string | null
endsAt
required
string | null
ended
required
boolean
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string

Example

{
"contact": {
"clients": [
{
"kind": "company"
}
]
},
"clients": [
{
"kind": "company"
}
],
"recentOrders": [
{
"status": "pending",
"paymentStatus": "unpaid",
"shipments": [
{
"state": "pending"
}
],
"documents": [
{
"kind": "invoice"
}
]
}
],
"pinnedOrders": [
{
"order": {
"status": "pending",
"paymentStatus": "unpaid",
"shipments": [
{
"state": "pending"
}
],
"documents": [
{
"kind": "invoice"
}
]
}
}
],
"subscriptions": [
{
"status": "trialing",
"interval": "day"
}
],
"endedSubscription": {
"status": "trialing",
"interval": "day"
}
}

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