Skip to main content
GET
/
purchases
/
{purchase_id}
Error
A valid request URL is required to generate request examples
{
  "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"
  }
}

​
Required Scopes

capi:read - Read access to Customer API resources

Authorizations

​
Authorization
string
header
required

Supertab OAuth2 flow for CAPI. See Authentication.

Headers

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

The version of the Customer API you are using. The version of the Customer API you are using.

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

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

Path Parameters

​
purchase_id
string<tagged_id>
required

An ID of a Purchase An ID of a Purchase

Response

Successful Response

​
id
string<tagged_id> | null
required

When a Purchase has been made with you, shows the ID of the Purchase. Otherwise obfuscated and is shown as null.

Example:

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

​
offering_id
string<tagged_id> | null
required

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

Example:

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

​
onetime_offering_id
string<tagged_id> | null
required

Which one-time offering was purchased, if this purchase resulted from purchasing a one-time offering.

Example:

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

​
purchased_at
string<date-time> | null
required

The time the purchase completed.

Example:

"2025-01-01T12:00:00Z"

​
completed_at
string<date-time> | null
required

The time the purchase completed.

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

Example:

"2025-01-01T12:00:00Z"

​
description
string
required

A summary of the purchase, usually including the site name and the type of a given entitlement.

​
price
Price · object
required

An amount of money

​
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:
completed,
pending,
abandoned
​
metadata
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

​
entitlement_status
EntitlementStatus · object
required

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