Spiffy

Create a program link Create a tracking link for an affiliate program.

create_affiliate_program_link

Add options to program Add one or more product options to an affiliate program.

create_affiliate_program_option

Add prices to program Add one or more product option prices to an affiliate program.

create_affiliate_program_price

Add card to customer Add a new payment card to customer using tokenized card data from payment gateway

create_customer_card

Add note to customer Add a note to customer activity history

create_customer_note

Add note to order Add a note to order activity history

create_order_note

Add notes to payment plan Add a note to a payment plan. Notes are stored as user events.

create_paymentplan_note

Create a product Create a new product with optional options and prices.

create_product

Create a product option Create a new option on a product.

create_product_option

Create a price on an option Create a new price on a product option. Omit frequency for a one-time (non-recurring) price; pass a frequency string (e.g. "month", "year") for a recurring price.

create_product_option_price

Create a price (optionless) Create a price on the uncategorized option (for subscriptions or products without options).

create_product_price

Create a promo Create a new promo/discount code.

create_promo

Create a saved report Create a new saved report. Call GET /v2/reports/types (list_report_types) first to discover valid type values, filter names, and relative_date presets. Scheduling: when frequency and relative_date are set, the report is emailed to its users on the computed schedule — exactly as dashboard-created scheduled reports are. frequency requires relative_date (a rolling window such as "Last Month"). users[] is optional — each entry takes {user_id} OR {email} (account users with report access). When scheduling and users is omitted, it defaults to YOU (the authorizing user), so "schedule this and email me" needs no ids at all. next_run_at is computed automatically from frequency + frequency_count; do not set it manually. Reports are created active (is_active=true, no draft state — unlike the dashboard). When name is omitted, a descriptive name is auto-generated from the type and filters (same as the dashboard) — but pass an explicit name when you want a predictable one.

create_report

Create a short-lived signed CSV download URL for a completed report run Generates a signed download URL for the full dataset of a completed run. One quota call, zero context — the URL is handed to the user or fetched with local tooling (e.g. curl). The URL requires no authentication (the signed token IS the credential). Expires in 15 minutes. Run must be completed (status=completed) — 409 otherwise; poll get_report_run first. Query/body param: dataset — which dataset to download (default: "default"); 400 lists available datasets. Response: { data: { url: string, expires_at: ISO8601 } }

create_report_export

Create a report run (queued for background execution) Create a new report run. Returns 202 Accepted with the run in "pending" status. Execution is asynchronous: a background worker picks up pending runs, so runs typically START within about 30 seconds of creation, then take a few seconds to a few minutes to finish depending on data volume. Polling: call get_report_run until status is "completed" or "failed". Each poll counts against the monthly API quota — poll no faster than every ~30 seconds (matches the worker pickup cadence); typical runs complete within a couple of minutes. Reading results: when completed, the run includes a stats block (flat_stats) that answers most questions — total revenue, count, etc. — without fetching rows. Read stats first; only fetch rows via list_report_run_results if you need detail. The run inherits the report's filters, timezone, and date range. For relative_date presets (e.g. "Last Month"), the start/end dates are resolved at run time. The report must have a date range — relative_date or a report_date filter — or this returns 400 (every report type date-filters its results).

create_report_run

Add notes to subscription Add a note to a subscription, saved as an event.

create_subscription_note

Create webhook endpoint Create a new webhook endpoint for the authenticated OAuth client

create_webhookendpoints

Delete a payout Delete an unpaid payout. Paid payouts cannot be deleted.

delete_affiliate_payout

Delete an affiliate program Soft delete an affiliate program (sets status to deleted).

delete_affiliate_program

Remove affiliate from program Deactivate an affiliate within a program.

delete_affiliate_program_affiliate

Remove checkout from program Soft delete a checkout from an affiliate program.

delete_affiliate_program_checkout

Delete a program link Soft delete a tracking link from an affiliate program.

delete_affiliate_program_link

Remove option from program Soft delete an option from an affiliate program.

delete_affiliate_program_option

Remove price from program Soft delete a price from an affiliate program.

delete_affiliate_program_price

Delete customer card Delete a payment card. Card must not be in use by active subscriptions or payment plans.

delete_customer_card

Remove order affiliate Remove affiliate attribution from an order

delete_order_affiliate

Delete a product Soft delete a product and all its options and prices.

delete_product

Delete a product option Soft delete an option and its prices.

delete_product_option

Delete a price Soft delete a price from a product option.

delete_product_option_price

Delete a promo Soft delete a promo code.

delete_promo

Delete a saved report Soft-delete a saved report (sets is_active=false). The report is no longer returned by the default list. Returns 204 on success.

delete_report

Delete webhook endpoint Delete a webhook endpoint

delete_webhookendpoints

Download payout CSV Download the payout commissions as a CSV file.

download_affiliate_payout_csv

Fetch the full markdown of a Spiffy help article by its markdown_url. Use this only when search_help_docs returned a relevant chunk but you need the complete article to cite multiple sections or verify context. For a single-answer question, the chunks from search_help_docs are usually enough.

get_help_article

Get details about the current account

get_account

Retrieve a single affiliate by id in a Spiffy account. Use this when you already know the affiliate's id and want its full details — typically after calling the corresponding list tool to discover ids. Supports expansions: customer, cards. Maps to GET /v2/affiliates/:id in the Spiffy v2 API.

get_affiliate

Get a payout Get one affiliate payout by its ID. The response lists the payout's commissions grouped by affiliate: each affiliate's name, email, PayPal email, total amount and currency, plus the IDs of the commission payments and adjustments included. Use list_affiliate_payouts to find payout IDs, or get_current_affiliate_payout for an unpaid payout.

get_affiliate_payout

Retrieve a single affiliate-program by id in a Spiffy account. Use this when you already know the affiliate-program's id and want its full details — typically after calling the corresponding list tool to discover ids. Maps to GET /v2/affiliates/programs/:program_id in the Spiffy v2 API.

get_affiliate_program

List available analytics metrics, dimensions, and groupings Returns the analytics catalog as data: every metric with its family, kind (flow/stock/derived), date anchor, and compatible groupBy values, plus dimensions, intervals, and comparison modes. Call this before query_analytics to construct valid queries.

get_analytics_capabilities

Retrieve a single checkout by id in a Spiffy account. Use this when you already know the checkout's id and want its full details — typically after calling the corresponding list tool to discover ids. Maps to GET /v2/checkouts/:id in the Spiffy v2 API.

get_checkout