Organization API: Billing & Payouts: Payouts
The 1 Organization API operations for payouts.
Part of Billing & Payouts.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/payouts |
The organization's hosting payouts, newest first |
The organization's hosting payouts, newest first
Section titled The organization's hosting payouts, newest firstGET /api/v1/orgs/{org_slug}/payouts
The organization's hosting payouts, newest first. Its store's payouts are
at /{org_slug}/commerce/payouts.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
limit |
query | integer | no | Default: 20. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
A 200 response is a list; each item has these fields:
| Field | Type |
|---|---|
[].id |
integer |
[].org_id |
integer |
[].amount |
string |
[].currency |
string |
[].platform_fee |
string |
[].net_amount |
string |
[].status |
string |
[].payout_method |
string |
[].period_start |
string (date-time) or null |
[].period_end |
string (date-time) or null |
[].scheduled_at |
string (date-time) or null |
[].completed_at |
string (date-time) or null |
[].created_at |
string (date-time) or null |