Bloss Docs

A creator's pay deal and payout history

Developers
GET
/brands/{brandId}/creators/{creatorId}/pay

From the creator's profile: their custom base pay and bonus deal (null fields mean they get the brand's), all-time paid and pending, where they're paid (payout provider account and PayPal, masked), and their payouts in this brand, newest first.

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
creatorId*string

A creator id in this brand.

Length1 <= length

Response Body

Success.

application/json
  1. response
currency*string
creator*
customBasePay*

Per-platform overrides apply when the brand pays per platform; null = the brand's rate.

customBonus*|

Their own bonus deal; null = the brand's bonus.

totals*
payoutAccount*
paypal*
payouts*array<>
curl -X GET 'https://example.com/api/v1/brands/string/creators/string/pay'
{  "currency": "USD",  "creator": {    "id": "string",    "name": "string",    "status": "string"  },  "customBasePay": {    "uniform": 0,    "instagram": 0,    "tiktok": 0,    "youtube": 0,    "facebook": 0  },  "customBonus": {    "model": "tiered",    "tiers": [      {        "viewThreshold": -9007199254740991,        "bonus": 0      }    ],    "linearRatePerThousand": 0,    "linearCap": 0,    "setAt": "string",    "note": "string"  },  "totals": {    "total": 0,    "paid": 0,    "pending": 0,    "paidEarly": 0,    "bonusPaidPerSet": 0  },  "payoutAccount": {    "provider": "string",    "status": "brand_not_connected",    "payoutEmail": "string",    "accountId": "string"  },  "paypal": {    "email": "string",    "locked": true  },  "payouts": [    {      "id": "string",      "cycleId": "string",      "periodStart": "string",      "periodEnd": "string",      "status": "string",      "basePay": 0,      "bonusPay": 0,      "paidEarly": 0,      "bonusPaidPerSet": 0,      "due": 0,      "total": 0,      "statsSnapshotDate": "string",      "paidAt": "string",      "paidVia": "string",      "transferId": "string",      "notes": "string"    }  ]}

Was this page helpful?