Disputes (chargebacks): list, inspect, submit evidence, or accept. Respond before evidence_details.due_by. See https://docs.stripe.com/api/disputes.

Functions

close-dispute

fn (dispute: Str): Map
fn (dispute: Str, options: ::stripe::api/RequestOptions | Map): Map

POST /v1/disputes/{dispute}/close - Accept the dispute (concede it as lost). Irreversible.

Example

::disputes ::stripe::disputes

closed ::disputes/close-dispute("dp_123")
closed.status

get-dispute

fn (dispute: Str): Map
fn (dispute: Str, params: Map): Map
fn (dispute: Str, params: Map, opts: Map): Map

GET /v1/disputes/{dispute} - Retrieve a dispute by ID.

Example

::disputes ::stripe::disputes

dispute ::disputes/get-dispute("dp_123", {expand: ["charge"]})
dispute.evidence_details.due_by

list-disputes

fn (): Map
fn (request: ListDisputesRequest): Map
fn (request: ListDisputesRequest, opts: Map): Map

GET /v1/disputes - List disputes, most recent first. Filter by charge or payment_intent. Check each dispute's status ("needs_response", "under_review", "won", "lost", ...).

Example

::disputes ::stripe::disputes

page ::disputes/list-disputes(::disputes/ListDisputesRequest({payment_intent: "pi_123"}))
to-answer filter(page.data, eq(%.status, "needs_response"))

update-dispute

fn (dispute: Str, request: UpdateDisputeRequest): Map
fn (dispute: Str, request: UpdateDisputeRequest, options: ::stripe::api/RequestOptions | Map): Map

POST /v1/disputes/{dispute} - Stage or submit evidence. Evidence fields are text or File IDs (customer_name, product_description, shipping_tracking_number, uncategorized_text, receipt, ...). submit defaults to true, which sends the evidence to the bank immediately and allows no further edits; pass submit: false to stage it.

Example

::disputes ::stripe::disputes

::disputes/update-dispute("dp_...", ::disputes/UpdateDisputeRequest({
  evidence: {
    customer_email_address: "alice@example.com",
    product_description: "Pro plan, monthly",
    uncategorized_text: "Customer used the service through the disputed period."
  },
  submit: false
}))

Types

ListDisputesRequest

ListDisputesRequest type {
    charge: Str?,
    payment_intent: Str?,
    created: Any?,
    limit: Int?,
    starting_after: Str?,
    ending_before: Str?,
    expand: Vec<Str>?
}

UpdateDisputeRequest

UpdateDisputeRequest type {
    evidence: Map?,
    submit: Bool?,
    metadata: Map?,
    expand: Vec<Str>?
}