get

/v4/offchain-billing/self/owed

Your creator's off-chain owed position (X-API-Key): credit balance, pending accrual, owed, and a per-campaign pending breakdown. Scoped to your own key.

Responses

200

Off-chain owed position for a client

Schema

objectOff-chain owed position for a client

creatorIdstring

required

creditBalanceUsdnumber

required

Current credit balance (signed; negative = already owes)

pendingAccrualUsdnumber

required

Distributed but not yet debited — what the next accrual adds

owedUsdnumber

required

max(0, pendingAccrualUsd − creditBalanceUsd)

linesobject[]

required

campaignIdstringInternal Campaign.id (database id)

onchainCampaignIdstringOn-chain campaign identifier

distributionChainIdnumberChain where rewards are distributed

chainNamestringHuman-readable distribution chain name

creatorAddressstring

startTimestampstringCampaign start (unix seconds)

endTimestampstringCampaign end (unix seconds)

endedbooleanWhether the campaign has ended (endTimestamp < now)

currentWeistringCumulative distributed (wei), creator address excluded

accruedWeistringCumulative distributed (wei) already accrued into credit debits

pendingWeistringDistribution not yet accrued (wei)

tokenSymbolstring

tokenAddressstringReward token address

tokenDecimalsnumber

tokenPriceUsdnumber

feeBpsnumberOff-chain fee in basis points

pendingUsdnumberfee × USD(pendingWei) — will be debited on next accrual

Example

{
  "creatorId": "string",
  "creditBalanceUsd": 0,
  "pendingAccrualUsd": 0,
  "owedUsd": 0,
  "lines": [
    {
      "campaignId": "string",
      "onchainCampaignId": "string",
      "distributionChainId": 0,
      "chainName": "string",
      "creatorAddress": "string",
      "startTimestamp": "string",
      "endTimestamp": "string",
      "ended": false,
      "currentWei": "string",
      "accruedWei": "string",
      "pendingWei": "string",
      "tokenSymbol": "string",
      "tokenAddress": "string",
      "tokenDecimals": 0,
      "tokenPriceUsd": 0,
      "feeBps": 0,
      "pendingUsd": 0
    }
  ]
}

get

https://api.merkl.xyz/v4/offchain-billing/self/owed

Merkl API

curl -X GET "https://api.merkl.xyz/v4/offchain-billing/self/owed"