Skip to content

The Store entity at YouCan. Returned by the GET /me endpoint.

Attribute NameTypeDescription
idstringIdentifier (UUID)
store_idstringAlias for id
slugstringStore URL slug
namestringStore display name
is_staffboolWhether the store owner is a staff account
emailstringStore owner email
due_amountstringTotal amount due — sum of due_amount and unpaid_invoices_amount
balancefloatCurrent store balance
unpaid_invoices_amountstringSum of all unpaid invoice amounts
currencyobjectStore default currency
domainstringStore domain
statusintStore status code
status_textstringStore status label
closed_atint, nullUnix timestamp of scheduled deletion date, or null if no deletion is pending
pack_idstringIdentifier of the active subscription plan (UUID)
logostring, nullURL of the store logo
first_namestring, nullOwner first name
last_namestring, nullOwner last name
full_namestring, nullOwner full name
phonestring, nullOwner phone number
biostring, nullStore bio
websitestring, nullStore website URL
noticesobjectKey-value map of active notices (e.g. gateway warnings)
is_activeboolWhether the store is active
is_email_verifiedboolWhether the owner email is verified
can_requestboolWhether the store can request deletion
can_cancelboolWhether the store can cancel a pending deletion request
is_devboolWhether the store is in development mode

Currency

Attribute NameTypeDescription
codestringISO 4217 currency code (e.g. "USD")
symbolstringCurrency symbol (e.g. "$")