Bloss Docs

The brand's pay rules and payout provider

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

How this brand pays creators, as on Settings › Rules: base pay per set (pair) — one rate, or one per platform — the minimum views a set needs and how they're counted, the payout model (cycles or a running ledger), the bonus (view tiers or a rate per 1,000 views with an optional cap), the referral bonus, instant base pay, the base-pay deadline, and the payout provider with whether it's connected. Provider credentials never appear; the provider account id is masked.

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

The brand's IANA time zone; every calendar day in the Brand API is in it.

basePay*
minimumViews*
payoutModel*string

How earnings accrue: per payout cycle, or a running ledger.

Value in"cycle""ledger"
ledger*
cycles*
bonus*
referralBonus*
instantBasePay*
basePayDeadline*|

Campaign reporting cutoff, YYYY-MM-DD in the brand's time zone. Advisory: sets that qualify after it are flagged late, never refused.

payoutProvider*
curl -X GET 'https://example.com/api/v1/brands/string/payout-settings'
{  "currency": "USD",  "timeZone": "string",  "basePay": {    "mode": "uniform",    "uniform": 0,    "perPlatform": {      "instagram": 0,      "tiktok": 0,      "youtube": 0,      "facebook": 0    },    "requirement": "all"  },  "minimumViews": {    "threshold": -9007199254740991,    "mode": "all"  },  "payoutModel": "cycle",  "ledger": {    "expirationDays": -9007199254740991,    "autoRunEnabled": true,    "autoRunIntervalDays": -9007199254740991  },  "cycles": {    "durationDays": -9007199254740991,    "autoRecurringEnabled": true  },  "bonus": {    "model": "tiered",    "aggregateMode": true,    "tiers": [      {        "viewThreshold": -9007199254740991,        "bonus": 0      }    ],    "linearRatePerThousand": 0,    "linearCap": 0  },  "referralBonus": {    "enabled": true,    "amount": 0  },  "instantBasePay": {    "enabled": true,    "minConnectedAccounts": -9007199254740991,    "requiredPlatforms": [      "string"    ],    "minAudiencePct": -9007199254740991  },  "basePayDeadline": "string",  "payoutProvider": {    "id": "whop",    "name": "string",    "connected": true,    "mode": "test",    "accountId": "string"  }}

Was this page helpful?