Retrieve a recovery case
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Response
Returns a recovery case object if a valid identifier was provided.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
recovery_case The date and time the case was canceled.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
The customer the case is recovering from.
The date and time the invoices were enrolled in recovery.
The ID of the user who enrolled the case, if it was enrolled from the dashboard.
The percentage of each recovered payment charged as a recovery fee.
The URL of the hosted recovery page, where the customer can pay or set up a payment plan.
The date and time the customer was last contacted about the case.
The active payment plan for the case, if the customer has accepted one.
The date and time every enrolled invoice was fully paid.
The status of the case.
open, plan_active, recovered, canceled The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The total amount outstanding across the enrolled invoices when the case was opened.
The amount collected against the enrolled invoices since the case was opened.
The number of escalated recovery emails sent for the case.
The total recovery fee charged against the amount recovered, including tax.
The IDs of the invoices enrolled in the case.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.