Skip to content

Stripe: Update a dispute — disputes post Disputes Dispute

Stripe disputes.postDisputesDispute: arguments, response, policy and SDK examples.

← Disputes operations · Get started

Operation stripe.postdisputesdispute

Provider route: POST /v1/disputes/{dispute}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["disputes"]["postDisputesDispute"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.disputes.postDisputesDispute(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.disputes.post_disputes_dispute(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.disputestringRequired within parentMaximum length: 5000
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptionalMinimum length: 1
Maximum length: 255
bodyModelOptionalExpand Post Charges Charge Dispute — request body — body

Referenced models: Post Charges Charge Dispute — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Close a dispute — response body

Referenced models: Close a dispute — response body

711 more schemas are linked from the tables above, on the schema pages.

Close a dispute — response body
FieldTypePresenceDescription and constraints
$objectRootA dispute occurs when a customer questions your charge with their card issuer.
When this happens, you have the opportunity to respond to the dispute with
evidence that shows that the charge is legitimate.

Related guide: [Disputes and fraud](https://docs.stripe.com/disputes)
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeDisputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_transactionsarrayRequired within parentList of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
balance_transactions[]ModelEach itemExpand Retrieve a balance transaction — balance get Balance History Id — response body
chargeJSONRequired within parentID of the charge that's disputed.
charge (anyOf 1)stringAlternativeMaximum length: 5000
charge (anyOf 2)ModelAlternativeExpand Create a charge — response body
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
Format: currency
enhanced_eligibility_typesarrayRequired within parentList of eligibility types that are included in `enhanced_evidence`.
enhanced_eligibility_types[]stringEach itemKnown values: mastercard_compliance, visa_compelling_evidence_3, visa_compliance
evidenceModelRequired within parentExpand Close a dispute — response body — evidence
evidence_detailsModelRequired within parentExpand Close a dispute — response body — evidence details
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
is_charge_refundablebooleanRequired within parentIf true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: dispute
payment_intentJSONOptional
payment_intent (anyOf 1)JSONAlternativeID of the PaymentIntent that's disputed.
payment_intent (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
payment_intent (anyOf 1) (anyOf 2)ModelAlternativeExpand Cancel a Payment Intent — response body
payment_intent (anyOf 2)nullAlternative
payment_method_detailsModelOptionalExpand Close a dispute — response body — payment method details
reasonstringRequired within parentReason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories).
Maximum length: 5000
statusstringRequired within parentThe current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
Known values: lost, needs_response, prevented, under_review, warning_closed, warning_needs_response, warning_under_review, won

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Create a charge — response body, Close a dispute — response body — evidence, Close a dispute — response body — evidence details, Close a dispute — response body — payment method details, Cancel a Payment Intent — response body

Post Charges Charge Dispute — request body — body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
evidenceModelOptionalExpand Post Charges Charge Dispute — request body — body evidence
expandarrayOptionalSpecifies which fields in the response should be expanded.
expand[]stringEach itemMaximum length: 5000
metadataJSONOptionalSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
metadata (anyOf 1)objectAlternativeAdditional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keys
metadata (anyOf 2)stringAlternativeOne of:
submitbooleanOptionalWhether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).

Referenced models: Post Charges Charge Dispute — request body — body evidence

Close a dispute — response body — evidence details
FieldTypePresenceDescription and constraints
$objectRoot
due_byJSONOptional
due_by (anyOf 1)JSONAlternative
due_by (anyOf 1) (anyOf 1)integerAlternativeDate by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.
Format: unix-time
due_by (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
due_by (anyOf 2)nullAlternative
enhanced_eligibilityModelRequired within parentExpand Close a dispute — response body — evidence details enhanced eligibility
has_evidencebooleanRequired within parentWhether evidence has been staged for this dispute.
past_duebooleanRequired within parentWhether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.
submission_countJSONRequired within parent
submission_count (anyOf 1)integerAlternativeThe number of times evidence has been submitted. Typically, you may only submit evidence once.
submission_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Close a dispute — response body — evidence details enhanced eligibility

Close a dispute — response body — payment method details
FieldTypePresenceDescription and constraints
$objectRoot
amazon_payModelOptionalExpand Close a dispute — response body — payment method details amazon pay
cardModelOptionalExpand Close a dispute — response body — payment method details card
klarnaModelOptionalExpand Close a dispute — response body — payment method details klarna
paypalModelOptionalExpand Close a dispute — response body — payment method details paypal
typestringRequired within parentPayment method type.
Known values: amazon_pay, card, klarna, paypal

Referenced models: Close a dispute — response body — payment method details amazon pay, Close a dispute — response body — payment method details card, Close a dispute — response body — payment method details klarna, Close a dispute — response body — payment method details paypal

Create a Payment Method — response body — zip
FieldTypePresenceDescription and constraints
$objectRoot

SDK function policy ID: stripe.postdisputesdispute. Catalog operation: PostDisputesDispute. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.