Update a charge

Indicate a subscription charge as either reverted or refunded. Note that modifying a charge is only allowed if you are managing the payment process, and marking a charge as reverted or refunded is mutually exclusive.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Mark a charge as reverted

PATCH /v1/subscription_charges/8144dea5-b2af-4615-b7df-dcfd43edc498
{
  "reverted_at": "2024-05-01T17:28:33.689374Z"
}

Mark a charge as refunded

PATCH /v1/subscription_charges/8144dea5-b2af-4615-b7df-dcfd43edc498
{
  "refunded_at": "2024-04-05T17:28:33.689374Z",
  "amount_refunded": 1000,
}

Returns
A subscription charge object is returned if the charge update succeeded. This call will return an error if something goes wrong.

Body Params
date-time

The time at which the charge was reverted.

date-time

The time at which the charge was refunded.

string

Positive integer representing the amount in cents that was reverted. This field is required if 'refunded_at' is set.

Language
LoadingLoading…