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

Price a private lesson booking exactly as create_private_lesson_booking will.

Price a private lesson booking exactly as create_private_lesson_booking will. An organization-scoped read using JSON filter arguments; requires private_lessons.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/quote_private_lesson
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
household_idstringrequired

Opaque Soljio resource ID.

min length 1
instructor_idstring

Opaque Soljio resource ID.

min length 1
lesson_type_idstringrequired

Opaque Soljio resource ID.

min length 1
lessonsobject[]required
Show properties
Array of object
guest_emailsstring[]required
participant_idsstring[]required
starts_atstring<date-time>required
location_idstringrequired

Opaque Soljio resource ID.

min length 1
replacesobject
Show properties
appointment_idsstring[]required
booking_idstringrequired

Opaque Soljio resource ID.

min length 1
nownumberrequired
overridebooleanrequired
use_creditsbooleanrequired
Responses
200

Successful read.

dataobjectrequired
Show properties
available_creditsnumberrequired
cancellation_hoursnumberrequired
creditsnumberrequired
currencystringrequired
due_minornumberrequired
instructorobject
Show properties
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
invitation_hoursnumberrequired
lessonsobject[]required
Show properties
Array of object
creditsnumberrequired
due_amount_minornumberrequired
ends_atstring<date-time>
problemstring
starts_atstring<date-time>required
studentsnumberrequired
total_amount_minornumberrequired
unit_amount_minornumberrequired
needs_approvalbooleanrequired
online_paymentsbooleanrequired
pack_idsstring[]required
pay_later_allowedbooleanrequired
timezonestringrequired
total_minornumberrequired
transfer_minornumberrequired
waiver_neededbooleanrequired
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/quote_private_lesson' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "household_id": "string",
  "instructor_id": "string",
  "lesson_type_id": "string",
  "lessons": [
    {
      "guest_emails": [
        "string"
      ],
      "participant_ids": [
        "string"
      ],
      "starts_at": "2019-08-24T14:15:22Z"
    }
  ],
  "location_id": "string",
  "replaces": {
    "appointment_ids": [
      "string"
    ],
    "booking_id": "string"
  },
  "now": 0,
  "override": true,
  "use_credits": true
}'
Response
{
  "data": {
    "available_credits": 0,
    "cancellation_hours": 0,
    "credits": 0,
    "currency": "string",
    "due_minor": 0,
    "instructor": {
      "id": "string",
      "name": "string"
    },
    "invitation_hours": 0,
    "lessons": [
      {
        "credits": 0,
        "due_amount_minor": 0,
        "ends_at": "2019-08-24T14:15:22Z",
        "problem": "string",
        "starts_at": "2019-08-24T14:15:22Z",
        "students": 0,
        "total_amount_minor": 0,
        "unit_amount_minor": 0
      }
    ],
    "needs_approval": true,
    "online_payments": true,
    "pack_ids": [
      "string"
    ],
    "pay_later_allowed": true,
    "timezone": "string",
    "total_minor": 0,
    "transfer_minor": 0,
    "waiver_needed": true
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}