Meta Ads

Meta Ads creator payout balances

Changed on

Per-creator rev-share payout balances for the shop (the Meta Ads Payouts tab), plus summary totals: total owed, ready to pay, and paid in the last 30 days. These are Meta rev-share Stripe payouts and are distinct from Creator Community campaign payments at /campaigns/payments/*. All cents are in the shop's Meta ad account currency (echoed as currency). Single shop only.

get/meta-ads/payouts

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/meta-ads/payouts
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Response

Successful Response

total_owed_centsinteger

Sum of balance_owed_cents, cents.

ready_centsinteger

Balance ready to pay (equals total_owed in V1), cents.

paid_period_centsinteger

Sum of transfers in the last 30 days, cents.

currencystring nullable

ISO 4217 currency of the shop's connected Meta ad account. Null when no ad account is connected or the currency is unknown.

Changes

    • breaking

      the // response's property type changed from string to no type for status

    • warning

      added the new complete enum value to the // response property for the response status

    • warning

      added the new missing enum value to the // response property for the response status

    • warning

      added the new unknown enum value to the // response property for the response status

    • info

      api operation id payouts_meta_ads_payouts_get removed and replaced with meta_ads_payouts

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status