A premium payout is a revenue-share payout earned from a premium subscription sale attributed to the partner (for example, a Wix.com, Studio, or POS plan). Premium payouts are generated automatically by Wix and can't be created by partners. Partners read them to see what they earned, the payout's approval status, and whether it was invoiced.
Amount earned by the partner for this payout, in USD.
Date and time the payout record was created in Wix's systems. This is when Wix recorded the earning, not when the subscription was charged. For the charge date, use transactionDate.
Payout ID.
ID of the partner payout invoice this payout was included in, once invoiced. Empty until the payout is invoiced. This is the partner's own payout invoice, not the invoice the client was charged on for the subscription.
This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose invoicesRefCodes contains this value, and read that invoice's status to see whether it was paid.
ID of the meta site (the Wix site) that the partner receives this payout for. The Wix Studio dashboard displays the site's name and domain instead of this ID.
Whether this is a cancellation or refund payout. When true, the payout carries a negative amount that offsets a previous earning. Negative payouts are returned by queries like any other payout, and count toward totals, so don't filter them out when summing.
Fractional revenue-share percent applied to transactionAmount to calculate amount. For example, 0.05 means 0.05%. The earned amount is transactionAmount * paymentRevenueSharePercent / 100.
ID of the premium product that the payout relates to. The Wix Studio dashboard displays the product's plan name instead of this ID. For the plan family, use premiumPlanType.
Revision number, which increments by 1 each time the PremiumPayout is updated. To prevent conflicting changes, the current revision must be passed when updating the PremiumPayout.
Name of the site (metaSiteId) that the partner receives this payout for, as it appeared when the payout was created. A snapshot of a past state, so it doesn't follow later renames of the site, and it's truncated to 200 UTF-16 code units, so a name using emoji or a non-Latin script can be cut shorter than 200 visible characters. The cut never splits a surrogate pair, but it can split a longer sequence such as an emoji built from several joined characters. Best effort - it may be empty, and it's always empty on payouts created before Wix started capturing it. Query Premium Payouts can't filter or sort on it, so use metaSiteId as the stable key.
Subscription charge the payout was calculated from, in USD. This is what the client paid Wix for the subscription, not what the partner earned - see amount.
The Wix Studio dashboard doesn't display this value. For a regular payout it can be derived from the earning and the rate: transactionAmount = amount / (paymentRevenueSharePercent / 100). The derivation doesn't hold when negative is true - a reversal carries a negative amount but keeps the original positive charge in transactionAmount.
Date of the subscription transaction that this payout was earned on.
Date and time the payout record was last updated, for example when its status was resolved. Not the date of the subscription charge. For the charge date, use transactionDate.