Bloss Docs

Payout cycles with their totals

Developers
GET
/brands/{brandId}/payout-cycles

Every payout cycle, newest first, with what it earned, paid and still owes, and how many creators it pays, as on Payouts › Cycles; plus the all-time totals shown above the list. Get one cycle's creators from GET /brands/{brandId}/payout-cycles/{cycleId}/payouts. Like opening the Cycles tab, this creates the next cycle of an auto-recurring series when the latest one has ended.

Authorization

bearerAuth payouts:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: payouts:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Response Body

Success.

application/json
  1. response
currency*string
summary*
data*array<>
curl -X GET 'https://example.com/api/v1/brands/string/payout-cycles'
{  "currency": "USD",  "summary": {    "paid": 0,    "pending": 0,    "paidEarly": 0,    "bonusPaidPerSet": 0,    "total": 0  },  "data": [    {      "total": 0,      "paid": 0,      "pending": 0,      "paidEarly": 0,      "bonusPaidPerSet": 0,      "id": "string",      "startDate": "string",      "endDate": "string",      "status": "string",      "active": true,      "ended": true,      "creatorCount": -9007199254740991,      "paidCount": -9007199254740991,      "pendingCount": -9007199254740991,      "paidAt": "string",      "notes": "string",      "lastCalculatedAt": "string"    }  ]}

Was this page helpful?