Earnings caps for creators

What's new

Creators carry an optional earnings_cap that limits how much a creator can earn within a single period. A cap is an object with limit_usd_cents, a non-negative integer, and a period of week or month. The counter resets at the start of each period in UTC, and null means the creator is uncapped.

Impact

Rewards for a creator can be bounded without deactivating the creator or editing their coupon. On update_creator, send an object to set or change the cap, send null to remove it, and omit the field to leave the current cap untouched. create_creator does not accept a cap, so new creators start uncapped and you apply a cap with a follow-up update.

Changes

Resource	Change
update_creator	Added optional earnings_cap to the request body
get_creators, create_creator, get_creator, update_creator	Added earnings_cap to creator responses
Components	Added the CreatorEarningsCap and CreatorEarningsCapPeriod schemas

Upgrade

• No action required. Existing creators read back earnings_cap as null and keep earning without a limit.
• To cap a creator, pass earnings_cap with limit_usd_cents and period to update_creator.
• If you build creator update payloads from a full read model, be aware that sending earnings_cap: null clears an existing cap. Omit the key instead when you only mean to leave it alone.

Need help?
Contact our integration team at integration@aghanim.com