Skip to main content
GET
/
v1
/
account
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/account \
  --header 'Authorization: Bearer <token>'
{
  "id": "dae0a15c-1bf4-47df-99d2-a7b4878fff3d",
  "object": "account",
  "cache_keys": {
    "coupons": "coupons/query-67f6db0385a025ac0aaf53d819932433-2-20260108220052480272",
    "display_currencies": "display_currencies/query-e80111207f8184be554ef8f81a205f3d-1-20260108220052474021",
    "manual_payment_methods": "manual_payment_methods/query-65e22d3bfe0bece044892d983af185b0-0",
    "processors": "processors/query-88abaa0af9eae81ffe4d01df70a04fc1-1-20260108220052515563",
    "products": "products/query-0c2ca3a15afd6457eebe1b2594411e26-0",
    "product_collections": "product_collections/query-61ef1dfd9e7bd79faf84c77503c41438-0",
    "reviews": "reviews/query-10843b4a7215af5da9efd19c85741485-0",
    "webhook_endpoints": "webhook_endpoints/query-b0340d0f91ddae73649d2fb64ae82a23-0"
  },
  "claimed": true,
  "claim_url": null,
  "claim_window_ends_at": null,
  "currency": "usd",
  "currency_locked": false,
  "locale": "en",
  "medias_total_byte_size": 0,
  "name": "Test Account",
  "slug": "test-account",
  "time_zone": "Etc/UTC",
  "url": null,
  "plan": {
    "free": true,
    "name": "Launch"
  },
  "public_token": "pt_DVJBaPCgTisnaML7ihk7pgAT",
  "seeded_at": null,
  "abandoned_checkout_protocol": "7aa5f319-230e-4e53-9296-ec325c036e32",
  "affiliation_protocol": "6655ed3e-e99b-4ae4-b16f-336f711cfdb2",
  "brand": "827ebc0a-e387-40b8-b5f0-1db431d659d1",
  "checkout_portal_protocol": "3b711cad-4ef8-4884-bde5-28fbd2c78b9e",
  "customer_notification_protocol": "7689a0f4-a092-4565-8fb0-c6aaf3b106a5",
  "customer_portal_protocol": "7e051b53-ea7f-4e3c-b1b9-84c6da612c84",
  "order_protocol": "4ee9bc89-95ae-4caa-8009-eaf1f2144755",
  "review_protocol": "02353566-880a-43e7-8195-0e83d482f3e1",
  "shipping_protocol": "dede940f-d0de-4c70-b92f-f966451ea1bb",
  "subscription_protocol": "377b569e-a48a-43f3-8364-7fc5a61d0199",
  "tax_protocol": "7b9b13be-5e5a-4518-909d-580e6adef13c",
  "test_data_purged_at": null,
  "created_at": 1767909651,
  "updated_at": 1767909651
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
currency
string

The default currency for this account. This will be used as the default value for Price, Checkout, and other objects that have the currency attribute.

​
name
string

The full name, business name, or other short descriptor for this account.

​
locale
string

The language that will be used for all customer notifications, invoices, etc. Current available locales are en, bg, de, es, fr, it, ja, nl, pl, pt, pt_br.

​
time_zone
string

The time zone of the account. Values must be a valid IANA time zone database identifier.

​
url
string | null

The URL of this account's store. This will be used as the base for all redirects back to your store.

​
abandoned_checkout_protocol

Expandable – The associated abandoned checkout protocol ID.

​
affililiation_protocol

Expandable – The associated affililiation protocol ID.

​
brand

Expandable – The associated brand ID.

​
cache_keys
object

A collection of cache keys for various resource collections on this account. These values can be used to invalidate your local cache for each resource collection.

​
claimed
boolean

Whether or not this account has been claimed yet.

​
claim_url
string | null

If not claimed, the URL where this account can be claimed.

​
claim_window_ends_at
integer | null

If not claimed, the time at which the claim window for this account ends. Measured in seconds since the Unix epoch.

​
currency_locked
boolean

Whether or not the currency is locked for this account. The currency is locked once the first live order is created.

​
checkout_portal_protocol

Expandable – The associated checkout portal protocol ID.

​
customer_notification_protocol

Expandable – The associated customer notification protocol ID.

​
customer_portal_protocol

Expandable – The associated customer portal protocol ID.

​
entitlements
object

The specific features that this account is entitled to.

​
medias_total_byte_size
integer

The total number of bytes from this account's medias.

​
plan
object

Details of the current plan this account is on.

​
public_token
string

The public API token for this account.

​
review_protocol

Expandable – The associated review protocol ID.

​
shipping_protocol

Expandable – The associated shipping protocol ID.

​
subscription_protocol

Expandable – The associated subscription protocol ID.

​
tax_protocol

Expandable – The associated tax protocol ID.

​
seeded_at
integer | null

Time when the account was seeded.

​
test_data_purged_at
integer | null

Time at which the test data was last purged.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.