API reference / Disputes
Change the settings of disputes
Turns disputes on or off, says what the business sells and what its policies are, and says whether its backend sends the usage of the customer for each dispute. Send only what changes. Disputes turn on only with Stripe, Dodo Payments or Paddle connected. The Stripe key of the workspace needs Write access to Disputes and to Files for the answers. Owners and admins.
/api/v1/dispute-settingsOther ways to call it
troopy disputes update-settingsIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsononbooleandescriptionstring | nullWhat the business sells, in two or three sentences for a bank
kindenum<string>servicesmerchandise
usageFromBackendbooleanWith it on, a new dispute waits 60 minutes for the usage
refundPolicystring | nullThe refund policy, as the customer reads it. It goes as a document with a dispute about a refund or about what was sold
cancellationPolicystring | nullThe cancellation policy, as the customer reads it. It goes as a document with a dispute about a subscription or a refund
disclosurestring | nullHow a customer sees the policies before a payment, like: the checkout page links to the terms
Response
200 · application/jsondata*object13 properties
on*booleanWhether Troopy reads the disputes of the workspace's payment providers and prepares their evidence
connected*booleanWhether one of those providers is connected in this workspace
providers*array<object>The payment providers that Troopy reads disputes from, and whether this workspace connected each one
3 properties
id*enum<string>stripedodopaymentspaddle
name*stringconnected*booleandescription*string | nullWhat the business sells, as the bank reads it
kind*enum<string>servicesmerchandise
usageFromBackend*booleanWhether the backend of the business sends the usage of the customer for each dispute
refundPolicy*string | nullThe refund policy of the business, in its own words
cancellationPolicy*string | nullThe cancellation policy of the business, in its own words
disclosure*string | nullHow a customer sees the policies before a payment
autoSubmit*object | nullThe grant to submit without a person, while it is in force
6 properties
until*stringISO 8601 date and time
maxAmount*numberThe largest disputed amount that goes without a person, in the units of the currency
currency*stringdailyCap*integergrantedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringgrantedAt*stringISO 8601 date and time
ended*object | nullWhen the last grant ended, and why
2 properties
at*stringISO 8601 date and time
why*stringsyncedAt*string | nullWhen Troopy last read the disputes from the providers
error*string | nullWhat the last read of a provider said, when it failed