Error
A valid request URL is required to generate request examples{
"id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
"offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"onetime_offering_id": "onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"purchased_at": "2025-01-01T12:00:00Z",
"completed_at": "2025-01-01T12:00:00Z",
"description": "The Leek - 24 Hours Time Pass",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
"has_entitlement": true,
"expires": "2023-11-07T05:31:56Z",
"recurs_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Invalid authentication credentials",
"code": "invalid_credentials"
}
}{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected | Forbidden",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | forbidden"
}
}{
"error": {
"message": "Purchase not found",
"code": "purchase_not_found"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Endpoints
Retrieve a purchase
Retrieve a purchase
You may use this endpoint to poll pending purchases when you expect them to complete.
GET
/
purchases
/
{purchase_id}
Error
A valid request URL is required to generate request examples{
"id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
"offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"onetime_offering_id": "onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
"purchased_at": "2025-01-01T12:00:00Z",
"completed_at": "2025-01-01T12:00:00Z",
"description": "The Leek - 24 Hours Time Pass",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"status": "completed",
"metadata": {},
"entitlement_status": {
"content_key": "site.cf637646-71a4-430d-aaea-a66f1a48a83c",
"has_entitlement": true,
"expires": "2023-11-07T05:31:56Z",
"recurs_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Invalid authentication credentials",
"code": "invalid_credentials"
}
}{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected | Forbidden",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | forbidden"
}
}{
"error": {
"message": "Purchase not found",
"code": "purchase_not_found"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}capi:read - Read access to Customer API resourcesAuthorizations
Supertab OAuth2 flow for CAPI. See Authentication.
Headers
Path Parameters
Response
Successful Response
Was this page helpful?