Read Organization
Intent
Reads the organization without changing it.
When to call it
Call this after your application has received or stored the identifier for the organization.
Access boundary
Authorize the request with a token that carries organizations:read or organizations:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Response
Request completed successfully
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
Name: Organization name shown in checkout, customer portal, emails etc.
Slug: Unique organization slug in checkout, customer portal and credit card statements.
Avatar Url: Avatar URL shown in checkout, customer portal, emails etc.
Proration Behavior: Proration behavior applied when customer updates their subscription from the portal.
invoice, prorate, next_period, reset Indicates whether customers can update their subscriptions from the customer portal.
Email: Public support email.
Website: Official website of the organization.
Socials: Links to social profiles.
Status: Current organization status.
created, review, snoozed, denied, active, blocked, offboarding, offboarded Details Submitted At: When the business details were submitted for review.
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: Default tax behavior applied on products.
location, inclusive, exclusive Feature Settings: Organization feature settings.
Subscription Settings: Settings related to subscriptions management.
Customer Email Settings: Settings related to customer emails.
Customer Portal Settings: Settings related to the customer portal.
Identifier of the transactions account.
Identifier of the payout account.
Capabilities: Capabilities currently granted to the organization.
Country: Two-letter country code (ISO 3166-1 alpha-2).
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