Skip to main content
GET
Get Refund Preview

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Response

Success

The result of previewing a prorated refund for a subscription cancellation, without issuing any refund. Reflects what would be refunded based on the remaining billing period.

prorated_amount_available_to_refund
integer<int64>
required

Prorated amount available to refund, in the smallest currency unit (e.g., 1499 = $14.99 USD), based on the unused portion of the current billing period.

Example:

2500

invoice_amount_paid
integer<int64>
required

Total amount paid on the subscription's latest invoice, in the smallest currency unit (e.g., 2999 = $29.99 USD).

Example:

2500

current_period_start
string
required

Start of the current billing period, as an RFC 3339 timestamp.

Example:

"2026-06-15T14:30:00Z"

current_period_end
string
required

End of the current billing period, as an RFC 3339 timestamp.

Example:

"2026-06-15T14:30:00Z"

payment_method_id
string | null

The payment method ID that would be refunded, if available

Example:

"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

last4
string | null

Last 4 digits of the card that would be refunded, if available

Example:

"4242"