Get upcoming payout
get_upcoming_payoutRetrieve the next scheduled Gumroad payout for a seller profile, with optional sales and transaction details, to review expected earnings before funds are sent.
Instructions
Get upcoming payout. Reviewed native GET /payouts/upcoming; scope: view_payouts. Read only; no local effect approval required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label; never inherited credentials, ownership or scope proof. | |
| include_sales | No | (optional, default: "true") - Set to "false" to exclude the "sales", "refunded_sales", and "disputed_sales" details from the response. | |
| include_transactions | No | (optional, default: "false") - Set to "true" to include the same transaction details in the response as exported payout CSV. All balance-affecting transactions included in the payout will be listed in a "transactions" array. Each transaction will have these keys: { type:, date:, purchase_id:, item_name:, buyer_name:, buyer_email:, taxes:, shipping:, sale_price:, gumroad_fees:, net_total: }. The "type" of transactions can be "Sale", "Chargeback", "Full Refund", "Partial Refund", "PayPal Refund", "Stripe Connect Refund", "Affiliate Credit", "PayPal Connect Affiliate Fees", "Stripe Connect Affiliate Fees", "PayPal Payouts", "Stripe Connect Payouts", "Credit", "Payout Fee", and "Technical Adjustment". |