Skip to main content
GET
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:20

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

contact
string
contact[]
string[]
company
string
company[]
string[]
productOption
string
productOption[]
string[]
product.uuid
string
product.uuid[]
string[]
product.type
string
product.type[]
string[]
id
integer
id[]
integer[]
status
string
status[]
string[]
user
string
user[]
string[]
user.localCenter
string
user.localCenter[]
string[]
user.status
string
user.status[]
string[]
manualFeePayment
string
manualFeePayment[]
string[]
commentStatus
string
commentStatus[]
string[]
commentByUser
string
order[productOption.id]
enum<string>
default:asc
Available options:
asc,
desc
order[user.type.position]
enum<string>
default:asc
Available options:
asc,
desc
order[periodStart]
enum<string>
default:asc
Available options:
asc,
desc
order[periodEnd]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[user.lastName]
enum<string>
default:asc
Available options:
asc,
desc
order[stripePaymentDate]
enum<string>
default:asc
Available options:
asc,
desc
order[amount]
enum<string>
default:asc
Available options:
asc,
desc
order[status]
enum<string>
default:asc
Available options:
asc,
desc
exists[isRefunded]
boolean
exists[subscriptionProfile]
boolean
exists[identityReminderSent]
boolean
exists[identityReminder2Sent]
boolean
exists[identityReminder3Sent]
boolean
exists[commentByUser]
boolean
periodStart[before]
string
periodStart[strictly_before]
string
periodStart[after]
string
periodStart[strictly_after]
string
periodEnd[before]
string
periodEnd[strictly_before]
string
periodEnd[after]
string
periodEnd[strictly_after]
string
stripePaymentDate[before]
string
stripePaymentDate[strictly_before]
string
stripePaymentDate[after]
string
stripePaymentDate[strictly_after]
string

Response

200 - application/json

ProductPayment collection

id
integer
read-only
product
object | null
subscriptionProfile
object | null
amount
number
periodStart
string<date-time> | null
periodEnd
string<date-time> | null
stripeInvoiceId
string | null
isRefunded
boolean | null
contact
object | null
user
object | null
price
object | null
manualFeePayment
object | null
stripePaymentDate
string<date-time> | null
status
string
default:open
uid
string | null
currency
string | null
isPublic
boolean | null
identityReminderSent
boolean | null
productOption
object | null
dateCreated
string<date-time> | null
read-only
identity
object | null
localCenterOption
object | null
commentByUser
string | null
invoice
object | null