Organization API: Organizations & Members: Summary
The 1 Organization API operations for summary.
Part of Organizations & Members.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/summary |
The Overview's figures and what needs attention, in one answer |
The Overview's figures and what needs attention, in one answer
Section titled The Overview's figures and what needs attention, in one answerGET /api/v1/orgs/{org_slug}/summary
The Overview's figures and what needs attention, in one answer.
Every member gets customers and services (active and all
against the plan's limit: every account but a forum placeholder, every
service whatever its status, as the limits count them), products
(all and limit), storefront (custom_domain,
domain_verified, logo and colours_chosen: a colour other than
the column's default, or a settings change that named one) and store
(status, test_mode and can_go_live, or null without a store).
Tier 3 support and above add refunds (waiting and oldest_at).
Billing, admins and the owner add overdue (invoices and
by_currency), outstanding (outstanding_by_currency, as
stats/revenue answers it), disputes (open, those with no
outcome yet, and the earliest evidence_due_at), payout
(method, whether a destination is set and whether the billing mode
needed one), paynow (configured, in own-store billing modes
only), revenue (this month's volume so far in the organization's
currency, exchange_rate null when none converts US dollars to it and
the figures stay in USD) and cut (month_so_far's cut_usd,
rate_percent and exempt). A part the role may not read is left
out, not nulled.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |