Get the payment link
get_payment_linkIdempotent
Returns a hosted Stripe Checkout URL for the case at the live flat price, for the person to pay. The document is drafted automatically once payment goes through, usually within about 5 minutes. If the case carries an eligibility notice, the notice is returned and acknowledge_notice must be true before a link is issued.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| case_id | Yes | The case id returned by start_document. | |
| access_token | Yes | The access_token returned by start_document. | |
| registered_post | No | Add registered post delivery of a letter (extra fee, shown in list_services). | |
| acknowledge_notice | No | Set true after the person has heard the eligibility notice returned by answer_questions or a previous call. |