POST
/
purchases
/
offerings
{
  "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"
    }
  },
  "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"
  }
}

Required Scopes

capi:write - Write access to Customer API resources

Authorizations

​
Authorization
string
header
required

Supertab OAuth2 flow for CAPI. See Authentication.

Headers

​
x-api-version
string
default:9999-01-01

The version of the Customer API you are using.

​
x-supertab-client-id
string
required

Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.

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.