Skip to main content

BuyEducationRequest

Exactly one of planId or productId must be present; a body with neither is refused with 400 request.plan_id_required.

planIdstring<uuid>

The plan to buy: the planId the education products listing (and GET /v1/plans) returns. Send this or productId; one of them is required.

clientReferencestringrequired
Example: exam-5001
productIdstring<uuid>

Alias of planId, kept for existing integrations. Either the plan id or the canonical product id from the listing is accepted.

phoneNumberstringnullable

Optional - where the provider may SMS a copy of the PIN.

Example: 08030000000
BuyEducationRequest
{
  "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientReference": "exam-5001",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "phoneNumber": "08030000000"
}