Purchase an offering

POST

purchases

offerings

{
  "purchase": {
    "id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
    "offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
    "purchased_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "price": {
      "amount": 50,
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$",
        "base_unit": 100
      }
    },
    "status": "abandoned",
    "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": "<string>"
  }
}

Headers

x-api-version

string

default:2025-04-01

Example:

"2025-04-01"

x-supertab-client-id

string

required

Example:

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

Body

application/json

offering_id

string

required

Example:

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

currency_code

string

required

Required string length: 3

metadata

object

Response

201

application/json

Successful Response

purchase

object | null

required

Purchase created as a result of purchasing this offering.

A null value means no purchase was created, see action_required_details for the reason.

purchase.id

string | null

required

Example:

"purchase.cf637646-71a4-430d-aaea-a66f1a48a83c"

purchase.offering_id

string | null

required

Which offering was purchased, if this purchase resulted from purchasing a pre-defined offering.

Example:

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

purchase.purchased_at

string | null

required

The time the purchase completed.

purchase.completed_at

string | null

required

The time the purchase completed.

Where Supertab requires a payment this will be null until the payment completes.

purchase.description

string

required

purchase.price

object

required

An amount of money

purchase.status

enum<string>

required

The status of the purchase.

Purchases may be pending or completed.

Only completed purchases grant access, pending purchases are purchases which require payment before entitlement is granted

Available options:

abandoned,

completed,

pending

purchase.metadata

object

required

Freeform metadata associated with the purchase.

This can be used for e.g associating the purchase with a user identifier in your system

purchase.entitlement_status

object | null

required

The customer's access (if any) as a result of this purchase

action_required

boolean

required

Is further interaction with the customer required on Supertab in order to complete this purchase.

Most commonly this will be when Supertab required a customer to make a payment before continuing.

action_required_details

object | null

required

Details of what to do next to complete pending purchases

Retrieve site Retrieve a purchase

{
  "purchase": {
    "id": "purchase.cf637646-71a4-430d-aaea-a66f1a48a83c",
    "offering_id": "offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9",
    "purchased_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "price": {
      "amount": 50,
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$",
        "base_unit": 100
      }
    },
    "status": "abandoned",
    "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": "<string>"
  }
}

Reference

Guides

Endpoints

Headers

Body

Response