Skip to main content
POST
/
onetime_offerings
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "status": "new",
  "metadata": {},
  "items": [
    {
      "id": "<string>",
      "price": {
        "amount": 123,
        "currency": {
          "code": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "base_unit": 123
        }
      },
      "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": "<string>",
        "price": {
          "amount": 123,
          "currency": {
            "code": "<string>",
            "name": "<string>",
            "symbol": "<string>",
            "base_unit": 123
          }
        },
        "status": "completed",
        "metadata": {},
        "entitlement_status": {
          "content_key": "<string>",
          "has_entitlement": true,
          "expires": "2023-11-07T05:31:56Z",
          "recurs_at": "2023-11-07T05:31:56Z"
        }
      }
    }
  ],
  "price": {
    "amount": 123,
    "currency": {
      "code": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "base_unit": 123
    }
  }
}

​
Required Scopes

mapi:write - Write access to Merchant API resources

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-api-version
string<date>
default:2025-04-01

The version of the Merchant API you are using.

​
x-supertab-client-id
string<tagged_id>
required

Your Client ID with Supertab. Used to identify the Merchant that API calls operate upon.

Body

application/json
​
currency_code
string
required
Required string length: 3
​
items
CreateOnetimeOfferingItemRequest · object[]
required
​
metadata
Metadata · object

Response

Successful Response

​
id
string<tagged_id>
required
​
status
enum<string>
required

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.

Available options:
new,
purchasing_completed,
purchasing_pending,
purchasing_abandoned,
expired
​
metadata
Metadata · object
required

Any additional information about this one-time offering.

​
items
OnetimeOfferingItem · object[]
required

A list of items that belong to this one-time offering.

​
price
Price · object
required

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.