Substy Developers
Billing

Get agency creator payout balances

Read payout balances across agency creators. Inspect per-creator results for balances that could not be retrieved.

GET/v1/agencies/{agencyId}/payouts/balances

Read payout balances across agency creators. Inspect per-creator results for balances that could not be retrieved.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Query Parameters

creatorIds?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/payouts/balances" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "creators": [      {        "creatorId": "string",        "creatorName": "string",        "creatorPlatform": "string",        "balance": null,        "error": null      }    ],    "totalAvailable": 0,    "totalPending": 0,    "currency": "string",    "balancesByCurrency": [      {        "currency": "string",        "totalAvailable": null,        "totalPending": null,        "currentBalance": null      }    ],    "successCount": 0,    "errorCount": 0  },  "meta": {    "requestId": "string"  }}

Update agency billing details PATCH

Update the agency's billing identity and address details used for billing documents.

List agency payout requests GET

List payout requests across agency creators using limit and offset. Inspect each creator's result when some platform requests fail.