Unlock a case
unlock_casePay to unlock the full findings, the dispute letter and the phone script. With a shared_payment_token (a Stripe Shared Payment Token granted to the stripe_profile in the case summary's purchase), it charges $10.00 for this bill and unlocks the case in the same call. Without one, it returns a checkout URL and charges nothing itself. A case with no findings is refused: there is nothing to buy, and the user pays nothing when nothing is found. So is a case with nothing to act on yet (nothing_to_act_on), such as a bill sent without its Explanation of Benefits whose only finding is that the EOB is missing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | "one_bill" is $10 for this bill, charged once. "subscription" is the monthly membership, which unlocks up to 25 bills a calendar month for anyone in a household. It is sold only while the case summary's `purchase.options` lists it; otherwise unlock_case answers `monthly_tier_paused` and charges nothing. A member who already has a code passes `membership_token` instead. | |
| case_id | Yes | ||
| membership_token | No | An existing membership. If the user already subscribed, pass the token they were given and this bill unlocks immediately with nothing charged — a membership covers up to 25 bills a calendar month, including other people in the family. A membership that has used its 25 bills for the month answers membership_cap_reached; it is still valid, and a one-off unlock still works. | |
| shared_payment_token | No | A Stripe Shared Payment Token (`spt_…`) granted to the `stripe_profile` in the case summary's `purchase`, for at least $10.00 USD. When present, this call charges it once and unlocks the case; no checkout URL is returned. One bill only: a token pays once, so it cannot buy the membership, which renews. Present only when `purchase.options[].pay_with_shared_payment_token` is true. |