Charge
Expire a Charge
Merchants can programmatically expire an unpaid charge via the API. This is useful when you want to cancel a pending checkout session—for example, the order was cancelled, the customer abandoned the session, or you want to invalidate the payment link.
The charge must not have a successful or pending transaction. The token path parameter is the charge token—the same value as in the charge URL path and the token field on the charge object.
post/v1/charge/api-key/{token}/expire
Path parameters
tokenstring required
The charge token (e.g. the segment at the end of https://app.hel.io/charge/{token}).
Query parameters
apiKeystring required
Your API key, which can be generated from the Helio Dashboard settings page.
Response
The charge was expired successfully. No response body.
Changes
No recorded changes to this endpoint across all 1 revision of this API.