A valid request URL is required to generate request examples{
"purchases": [
{
"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"
}
}
],
"action_required": true,
"action_required_details": {
"next": "https://checkout.supertab.co?tab_id=tab.13de9ebb-83bd-4aeb-80aa-6f2a21c1be69",
"reason": "Payment required to complete purchase"
}
}{
"error": {
"message": "The given currency is not supported by the system",
"code": "currency_not_supported"
}
}{
"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",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}{
"error": {
"message": "One-time offering not found",
"code": "onetime_offering_not_found"
}
}{
"error": {
"message": "This one-time offering was already consumed | The amount of the Pay-Now tab is below the allowed limit | Purchases are not enabled for the merchant",
"code": "onetime_offering_already_consumed | pay_now_tab_amount_below_limit | purchases_not_enabled_for_merchant"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Purchase a one-time offering
Purchases a one-time offering by placing it on the customer’s current tab.
If the new purchase(s) causes the tab to become full a payment is required before the purchase(s) will complete.
A valid request URL is required to generate request examples{
"purchases": [
{
"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"
}
}
],
"action_required": true,
"action_required_details": {
"next": "https://checkout.supertab.co?tab_id=tab.13de9ebb-83bd-4aeb-80aa-6f2a21c1be69",
"reason": "Payment required to complete purchase"
}
}{
"error": {
"message": "The given currency is not supported by the system",
"code": "currency_not_supported"
}
}{
"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",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}{
"error": {
"message": "One-time offering not found",
"code": "onetime_offering_not_found"
}
}{
"error": {
"message": "This one-time offering was already consumed | The amount of the Pay-Now tab is below the allowed limit | Purchases are not enabled for the merchant",
"code": "onetime_offering_already_consumed | pay_now_tab_amount_below_limit | purchases_not_enabled_for_merchant"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Required Scopes
capi:write - Write access to Customer API resourcesAuthorizations
Supertab OAuth2 flow for CAPI. See Authentication.
Headers
The version of the Customer API you are using.
Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.
"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
Body
"onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"
Response
Successful Response
Purchases created as a result of purchasing this one-time offering.
An empty list means no purchases were created, see action_required_details for the reason.
Show child attributes
Show child attributes
Determines if further interaction with the customer required on Supertab in order to complete this purchases.
Most commonly this will be when Supertab required a customer to make a payment before continuing.
Details of what to do next to complete pending purchases
Show child attributes
Show child attributes
Was this page helpful?