Checkout
DocsThe token is a signed capability minted for this order id alone. The
response carries no buyer PII, attribution or client metadata, all of
which are console-only. deliverables appears once the
order is fulfilled.
publishableKeyX-Sorai-Key<token>A store's publishable key, spk_….
id*stringuuidtoken*stringThe token from the checkout response.
The order.
application/jsonid*stringuuidnumber*stringSR- plus ten unambiguous base32 characters.
status*OrderStatuspending means the order is still being set up and
will move on shortly; the buyer can already pay. Only Sorai moves an
order from one status to another.
"pending""awaiting_payment""paid""fulfilled""expired""cancelled""refunded"currency*string3 <= length <= 3subtotal_minor*integerint64discount_minor*integerint64fee_minor*integerint64total_minor*integerint64items*array<>custom_fields?payment?deliverables?array<>Present once the order is fulfilled.
created_at*stringdate-timepaid_at?stringdate-timefulfilled_at?stringdate-timerefunded_at?stringPresent once the order has been refunded; the buyer's entitlements and download links stop working at the same moment.
date-timecancelled_at?stringPresent once the order has been cancelled. Absent on an older order cancelled before Sorai recorded the time.
date-timeexpired_at?stringPresent once the order has expired unpaid. Absent on an older order expired before Sorai recorded the time.
date-timeoriginating_order_id?stringPresent when this order was created by accepting a post-payment offer; names the order that offer was shown on.
uuidoffer?The post-payment offer this order can still accept, shown after payment and before the checkout's own success action. Settled when the order was created, so a merchant changing the offer while the buyer is deciding cannot change what they were already shown. Either half is absent when it is not configured.
thank_you_url?stringPresent on a paid order when its product carries a thank-you redirect. The result page sends the buyer there after a short confirmation, with the order number appended as order_ref; never the buyer's own details or this order's status token.
uricurl -X GET 'https://api.sorai.ai/v1/public/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/status?token=string'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string", "status": "pending", "currency": "str", "subtotal_minor": 0, "discount_minor": 0, "fee_minor": 0, "total_minor": 0, "items": [ { "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1", "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c", "name": "string", "amount_minor": 0, "quantity": 0, "kind": "primary" } ], "custom_fields": {}, "payment": { "method": "string", "status": "pending", "conflict_reason": "product_not_active", "instrument": { "kind": "qr", "qr_string": "string", "bank": "string", "account_number": "string", "account_name": "string", "redirect_url": "http://example.com", "client_secret": "string", "instructions": { "locale": "string", "sections": [ { "title": "string", "steps": [ "string" ] } ] } }, "amount_minor": 0, "expires_at": "2019-08-24T14:15:22Z" }, "deliverables": [ { "filename": "string", "size": 0, "url": "http://example.com", "expires_at": "2019-08-24T14:15:22Z", "remaining_uses": 0 } ], "created_at": "2019-08-24T14:15:22Z", "paid_at": "2019-08-24T14:15:22Z", "fulfilled_at": "2019-08-24T14:15:22Z", "refunded_at": "2019-08-24T14:15:22Z", "cancelled_at": "2019-08-24T14:15:22Z", "expired_at": "2019-08-24T14:15:22Z", "originating_order_id": "e9764f39-0001-4bf3-b839-f95d91f3d21a", "offer": { "upsell": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "price": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "currency": "str", "amount_minor": 0, "pay_what_you_want": true, "min_minor": 0 }, "method": { "method": "string", "display_name": "string" } }, "downsell": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "price": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "currency": "str", "amount_minor": 0, "pay_what_you_want": true, "min_minor": 0 }, "method": { "method": "string", "display_name": "string" } }, "scope": "product" }, "thank_you_url": "http://example.com"}