Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Search enrollment and balance details.

Search enrollment and balance details. An organization-scoped read using JSON filter arguments; requires invoices.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/search_enrollments
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
enrollment_idstring

Opaque Soljio resource ID.

min length 1
offering_idstring

Opaque Soljio resource ID.

min length 1
pagination_optsobjectrequired
Show properties
cursorstring | nullrequired
Show properties
Any of:
string
string
null
null
num_itemsintegerrequired
min 1 · max 100
searchstring
statusstring
Responses
200

Successful read.

dataobjectrequired
Show properties
can_manage_paymentsbooleanrequired
can_manage_waitlistbooleanrequired
has_morebooleanrequired
next_cursorstring | nullrequired
Show properties
Any of:
string
string
null
null
offering_namestring
rowsobject[]required
Show properties
Array of object
amount_due_minornumber
amount_paid_minornumber
amount_refunded_minornumber
idstringrequired

Opaque Soljio resource ID.

min length 1
offering_idstringrequired

Opaque Soljio resource ID.

min length 1
offering_namestringrequired
outstanding_minornumber
participant_idstringrequired

Opaque Soljio resource ID.

min length 1
participant_namestringrequired
payment_statusstring
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
price_currencystring
session_idstring

Opaque Soljio resource ID.

min length 1
session_starts_atstring<date-time>
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
transfer_credit_minornumber
transfer_surplus_minornumber
waitlist_positionnumber
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/search_enrollments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "enrollment_id": "string",
  "offering_id": "string",
  "pagination_opts": {
    "cursor": "string",
    "num_items": 1
  },
  "search": "string",
  "status": "string"
}'
Response
{
  "data": {
    "can_manage_payments": true,
    "can_manage_waitlist": true,
    "has_more": true,
    "next_cursor": "string",
    "offering_name": "string",
    "rows": [
      {
        "amount_due_minor": 0,
        "amount_paid_minor": 0,
        "amount_refunded_minor": 0,
        "id": "string",
        "offering_id": "string",
        "offering_name": "string",
        "outstanding_minor": 0,
        "participant_id": "string",
        "participant_name": "string",
        "payment_status": "not_required",
        "price_currency": "string",
        "session_id": "string",
        "session_starts_at": "2019-08-24T14:15:22Z",
        "status": "pending",
        "transfer_credit_minor": 0,
        "transfer_surplus_minor": 0,
        "waitlist_position": 0
      }
    ]
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}