Create New One-Time Offering

POST

onetime_offerings

{
  "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
    }
  }
}

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

default:2025-04-01

The version of the Merchant API you are using.

x-supertab-client-id

string

required

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

Examples:

"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

Body

application/json

Response

201

application/json

Successful Response

The response is of type object.

{
  "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
    }
  }
}

POST

onetime_offerings

{
  "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
    }
  }
}

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

default:2025-04-01

The version of the Merchant API you are using.

x-supertab-client-id

string

required

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

Examples:

"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

"test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

Body

application/json

Response

201

application/json

Successful Response

The response is of type object.

{
  "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
    }
  }
}

Create New One-Time Offering

Required Scopes

Authorizations

Headers

Body

Response

Introduction

Reference

Endpoints

Webhooks

Create New One-Time Offering

Required Scopes

Authorizations

Headers

Body

Response