Skip to main content
GET
Read Organization

Authorizations

Authorization
string
header
required

Authentication: You can generate a Personal Access Token from your settings.

Path Parameters

id
string<uuid4>
required

Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

Response

Request completed successfully

created_at
string<date-time>
required

The time Ruba created this record.

modified_at
string<date-time> | null
required

The time this record last changed.

id
string<uuid4>
required

The stable identifier for this record.

name
string
required

Name: Organization name shown in checkout, customer portal, emails etc.

slug
string
required

Slug: Unique organization slug in checkout, customer portal and credit card statements.

avatar_url
string | null
required

Avatar Url: Avatar URL shown in checkout, customer portal, emails etc.

proration_behavior
enum<string>
required

Proration Behavior: Proration behavior applied when customer updates their subscription from the portal.

Available options:
invoice,
prorate,
next_period,
reset
allow_customer_updates
boolean
required

Indicates whether customers can update their subscriptions from the customer portal.

email
string | null
required

Email: Public support email.

website
string | null
required

Website: Official website of the organization.

socials
OrganizationSocialLink · object[]
required

Socials: Links to social profiles.

status
enum<string>
required

Status: Current organization status.

Available options:
created,
review,
snoozed,
denied,
active,
blocked,
offboarding,
offboarded
details_submitted_at
string<date-time> | null
required

Details Submitted At: When the business details were submitted for review.

default_presentment_currency
string
required

Default Presentment Currency: Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available.

default_tax_behavior
enum<string>
required

Default Tax Behavior: Default tax behavior applied on products.

Available options:
location,
inclusive,
exclusive
feature_settings
OrganizationFeatureSettings · object | null
required

Feature Settings: Organization feature settings.

subscription_settings
OrganizationSubscriptionSettings · object
required

Subscription Settings: Settings related to subscriptions management.

customer_email_settings
OrganizationCustomerEmailSettings · object
required

Customer Email Settings: Settings related to customer emails.

customer_portal_settings
OrganizationCustomerPortalSettings · object
required

Customer Portal Settings: Settings related to the customer portal.

account_id
string<uuid4> | null
required

Identifier of the transactions account.

payout_account_id
string<uuid4> | null
required

Identifier of the payout account.

capabilities
OrganizationCapabilities · object
required

Capabilities: Capabilities currently granted to the organization.

country
enum<string> | null

Country: Two-letter country code (ISO 3166-1 alpha-2).

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW