A valid request URL is required to generate request examples{
"id": "onetime_offering.61a54647-d5d7-44c4-b56c-d5b073759628",
"status": "new",
"metadata": {},
"items": [
{
"id": "onetime_offering_item.94703e8a-0352-444d-b78d-d5a347a8e09d",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"description": "<string>",
"metadata": {},
"purchase": {
"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"
}
}
}
],
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
}
}{
"error": {
"message": "Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system",
"code": "invalid_price | currency_not_enabled | 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": "Purchases are not enabled for the merchant",
"code": "purchases_not_enabled_for_merchant"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Create New One-Time Offering
Creates a onetime offering.
A valid request URL is required to generate request examples{
"id": "onetime_offering.61a54647-d5d7-44c4-b56c-d5b073759628",
"status": "new",
"metadata": {},
"items": [
{
"id": "onetime_offering_item.94703e8a-0352-444d-b78d-d5a347a8e09d",
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
},
"description": "<string>",
"metadata": {},
"purchase": {
"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"
}
}
}
],
"price": {
"amount": 50,
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"base_unit": 100
}
}
}{
"error": {
"message": "Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system",
"code": "invalid_price | currency_not_enabled | 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": "Purchases are not enabled for the merchant",
"code": "purchases_not_enabled_for_merchant"
}
}{
"error": [
{
"code": "validation_error",
"message": "Validation Error",
"errors": [
{
"attribute": "query -> subject",
"code": "missing",
"message": "field required"
}
]
}
]
}Required Scopes
mapi:write - Write access to Merchant API resourcesAuthorizations
Supertab OAuth2 flow for MAPI. See Authentication.
- Token URL
- https://auth.supertab.co/oauth2/token
Headers
The version of the Merchant 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
Response
Successful Response
"onetime_offering.61a54647-d5d7-44c4-b56c-d5b073759628"
The status of the one-time offering based on the fact of purchase.
It may be new, a purchase pending or a purchase completed.
Only status purchasing_completed means a payment for the one-time offering purchase has been successfully processed.
new, purchasing_completed, purchasing_pending, purchasing_abandoned, expired Any additional information about this one-time offering.
Show child attributes
Show child attributes
A list of items that belong to this one-time offering.
Show child attributes
Show child attributes
The price of this one-time offering combining all the one-time offering items' prices. It is always created on the fly based on the provided information when creating a one-time offering.
Show child attributes
Show child attributes
Was this page helpful?