GET
/
v1
/
purchases
/
{purchase_id}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
purchase_id
string
required

The id for a purchase

Response

200 - application/json

Status response for Purchase.

​
id
string
required
​
created_at
string
required
​
updated_at
string
required
​
purchase_date
string
required
​
merchant_id
string
required
​
summary
string
required
​
price
object
required
​
sales_model
enum<string>
required
Available options:
contribution,
single_purchase,
time_pass,
subscription,
managed_by_merchant
​
payment_model
enum<string>
required

Enumerates the various terms of purchase

PAY_NOW Payment should be made immediately

PAY_LATER Payment should be made when the global tab for a specific user reaches a pre-defined limit.

Deprecated: PAY_NOW_SUBSCRIPTION Payment should be made immediately and will recur periodically according to the recurring details specified in the item offering.

Available options:
pay_now,
pay_later,
pay_now_subscription
​
metadata
object
required
​
attributed_to
string | null
required
​
offering_id
string | null
required
​
purchase_intent_item_id
string | null
required
​
content_key
string | null
required
​
test_mode
boolean | null
default:
false
required
​
valid_from
string | null
required
​
valid_to
string | null
required
​
valid_timedelta
string | null
required
Required string length: 2 - 9
​
recurring_details
object | null
required
​
status
enum<string> | null
required

We use this enum to represent the status of a purchase.

The status can be:

  • completed: the purchase was successfully completed
  • pending: the purchase is pending
  • abandoned: the purchase was abandoned

The logic to determine the status of a purchase is: PAY_LATER on Tab -> purchase.status PAY_NOW in a paid Tab -> completed PAY_NOW in an unpaid Tab -> pending

Abandoned purchases are not being set at the moment.
Purchases are going to be marked as abandoned when new pending
purchases are added to the tab.
Available options:
abandoned,
completed,
pending