Endpoints
Attributes
Whether the dispute can be conceded to the customer with
POST /disputes/\{id} /accept. True only for a chargeback still awaiting a response, before
evidence_due_at, whose payment processor supports accepting disputes.
Inquiries are never acceptable.The customer who filed the dispute.
Properties
Properties
The customer’s email address. Requires the
member:email:read scope; null
without it.The evidence packet sent to the processor to contest the dispute.
Properties
Properties
Log of the customer’s access to the product, such as sign-in or download
activity.
The cancellation policy document. Defaults to the account’s cancellation policy, then its terms of service, then its return policy, then Whop’s platform policy.
Properties
Properties
The attachment’s ID.
null for a Whop-hosted policy, which is not an uploaded
file.Whether this is Whop’s own hosted policy, standing in because the seller
uploaded none. Sending it back on a PATCH changes nothing.
Correspondence with the customer, or proof they used the product.
Properties
Properties
The attachment’s ID.
null for a Whop-hosted policy, which is not an uploaded
file.Whether this is Whop’s own hosted policy, standing in because the seller
uploaded none. Sending it back on a PATCH changes nothing.
Additional evidence documents, beyond the four fixed slots — set via
evidence.documents on PATCH /disputes/\{id}. Each rides into the submitted packet under its document_type.Properties
Properties
BlurHash placeholder for an image or video. Null when unavailable or removed
by moderation.
The uploaded file’s MIME type. Uploads are restricted to the types the processor accepts, and rejected without one — never null.Available options:
application/pdf, application/json, image/jpeg, image/png, image/webpWhat this document proves.
return_policy, cancellation_policy and terms_of_service are the seller’s policy documents. A policy document replaces the account’s copy for this dispute. return_policy, cancellation_policy and customer_communication also replace the matching fixed evidence slot. shipping_policy is the seller’s shipping terms. customer_communication is correspondence with the buyer, such as a support thread or chat log. product_image is a photo of the product or service the buyer received. physical_fulfillment is proof that a physical order shipped and arrived. digital_fulfillment is proof that the buyer accessed a digital product. customer_order_history is the buyer’s past orders with this seller. prior_transactions is the buyer’s payment history across the platform, for a fraud defense. customer_session is checkout data, such as IP address, device fingerprint, AVS and CVV results, and the 3D Secure result. subscription is membership lifecycle evidence, such as renewals, cancellation and reminders sent. complete_evidence is the seller’s whole response as one PDF of at most 19 pages, and it must be the only document. Whop sends a complete_evidence document to the processor in place of every other evidence field, attachment and document.Available options: return_policy, shipping_policy, cancellation_policy, terms_of_service, physical_fulfillment, customer_order_history, product_image, prior_transactions, customer_session, digital_fulfillment, subscription, customer_communication, complete_evidenceAudio or video duration in seconds. Null when unavailable or removed by
moderation.
Image or video height in pixels. Null when unavailable or removed by
moderation.
The byte size each part (except the last) must be. Present only on create, and
only for multipart uploads.
The ID of the multipart upload, passed back to
complete. Present only on
create, and only for multipart uploads.Whether moderation removed the file. When
true, url serves a replacement
image. filename, size and content_type still describe the original file.Where the file is in its upload lifecycle.Available options:
pending, processing, ready, failedPresigned URL to PUT the file’s bytes to. Present only on create, and only for
single-part uploads.
A URL to download the file. Public files get a permanent CDN URL, and private
files get a signed URL that expires.
null until the upload has finished.
When moderation removes the file, a replacement image URL.public files are served from an unsigned CDN URL. private files are served from a signed URL that expires.Available options: public, privateThe refund policy document. Defaults to the account’s return policy, then its terms of service, then Whop’s platform policy.
Properties
Properties
The attachment’s ID.
null for a Whop-hosted policy, which is not an uploaded
file.Whether this is Whop’s own hosted policy, standing in because the seller
uploaded none. Sending it back on a PATCH changes nothing.
Supporting evidence that does not fit the other categories.
Properties
Properties
The attachment’s ID.
null for a Whop-hosted policy, which is not an uploaded
file.Whether this is Whop’s own hosted policy, standing in because the seller
uploaded none. Sending it back on a PATCH changes nothing.
The deadline to submit evidence, as an ISO 8601 timestamp.
null when the
network already auto-resolved the dispute (Visa RDR) with no evidence round,
or when the processor hasn’t reported a deadline for this dispute.Why evidence can no longer be edited.
null while evidence_editable is true.Available options: submitted, response_window_closed, not_contestableThe dispute fee charged to the account, in the currency it was collected in.
null when fee_charged is false.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
Whether Whop charged the account a dispute fee for this one.
false when the
payment was fully refunded before the dispute was opened, for a Visa RDR
resolution, and for an inquiry.Whether this is a pre-dispute inquiry rather than a formal chargeback.
Inquiries follow the same lifecycle but move no funds unless one escalates.
Everything the disputed payment charged for, in purchase order.
product_id and variant_id name the first of these; a cart’s later items appear only here. A payment made before items were recorded lists the single item its variant implies. Empty when the payment is not linked to a variant.Properties
Properties
Line item ID, prefixed
li_. Null when the payment predates item snapshots
and the item is read from the payment’s variant.The item’s name as shown at checkout (the product title, else the variant
title).
The product the variant belongs to, prefixed
prod_. On a payment that
predates item snapshots this falls back to the variant’s product, so it can be
set where the parent’s own product_id is null. Null for a variant with no
product.The variant’s stock keeping unit, free text set by the seller (e.g.
TSHIRT-LARGE-BLUE). Accounts with billing-reason SKU suffixes enabled
receive it stamped with why the charge happened: -S for a first subscription
charge, -R for a renewal, -C for a one-time purchase, -U when the
payment’s own metadata carries upsell: true, -F when nothing was charged.
Other billing reasons carry the bare SKU. null when the variant has no SKU
or has been deleted.The recorded amount for this item’s full quantity, before discounts, tax, and fees, in its purchase currency. Returns
null when no item amount was recorded.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The variant bought, prefixed
plan_. Null when the variant has since been
deleted.The payment being disputed.
Properties
Properties
Three-letter ISO currency code of the payment. Can differ from the dispute’s
currency when the processor settles in another currency.
The instrument this payment was made with, shaped for display: the method type, a buyer-facing name, the standard icon set, and the card facts, including the network transaction id the account uses for the card, when it was a card. Null when the payment names no method.
Properties
Properties
Card, Apple Pay, and Google Pay payments only: the card’s network, last four, issuer identification number, expiry, and network transaction id.
Properties
Properties
The network identifier (
visa, amex, …), matching card.networks entries
and saved card payment methods. Null when the vault did not record the
network.The issuer identification number, also called the BIN: the card’s leading six
or eight digits, which identify the issuing bank. Null when the processor did
not report it.
The network transaction id this account uses for the card. It’s this account’s own id, from its first customer-present charge or verification on the card, when Whop has one. Otherwise it’s an earlier network transaction id for this card, which can come from another account’s transaction or be one brought with the card. Cite it as the prior transaction on a later merchant-initiated charge of this card at this account. Null until there is one. A webhook sent as a payment is first recorded can carry
null, so retrieve the payment to read it.Buyer-facing instrument name — “Visa •••• 4242” when the card surfaced, else
the method’s own name (“Klarna”).
The standard icon set: square and card shapes, each in light and dark colorways.
Properties
Properties
The credit-card-proportioned tile (48x30).
Properties
Properties
The square tile (32x32).
Properties
Properties
Installment methods only: how many payments the charge splits into. Data, not
copy — compose and translate the label client-side.
Why the customer says they are disputing, normalized across processors and card networks.
other covers a processor reason Whop has not categorized yet.Available options: fraudulent, unrecognized, declined_authorization, product_not_received, product_unacceptable, subscription_canceled, credit_not_processed, duplicate, processing_error, documentation_request, bank_cannot_process, otherThe raw card-network or processor reason code, such as
10.4. Informational
only — reason is not derived from it.needs_response awaits evidence (after a processor refused a filing, submission_failure_reason says why); generating_response has evidence with the processor, not yet accepted; under_review is with the processor; won/lost are the rulings; prevented settles like lost. warning_ statuses are the inquiry tiers. Past evidence_due_at an open one reports under_review.Available options: needs_response, warning_needs_response, under_review, warning_under_review, generating_response, won, lost, prevented, warning_closedWhy the payment processor refused the last filing, in plain English, while the
dispute is back in
needs_response. Fix what it names and submit again. Only
on retrieve: dispute.updated reports the move back to needs_response, then
read this here.Dispute

