Skip to main content
POST
Preview Refund Allocation

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Body

application/json

An envelope wrapping a single checkout session object.

An envelope wrapping a single checkout session object.

checkout_session
object
required

The checkout session payload.

Example:

Response

Success

Preview of how a refund would be distributed across the session's payment methods.

allocations
object[]
required

The computed refund amount allocated to each payment method. No refund is executed.