Get cost breakdown request link
request_cost_breakdown_linkReturns only the personal link (quoteRequestUrl) for one programme and family: the calculator page on goodbyematrix.com with the family already filled in, where the user requests the detailed cost breakdown with the exact amounts by e-mail from the GoodbyeMatrix team. The link carries the family only, never contact details; the user enters their contact details on that page, checks them and sends the request personally; the privacy consent is never preselected. Read-only: it returns a URL only; nothing is sent, booked or stored.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| family | Yes | Everyone who applies together. The first person is the main applicant (role "main"); only the first person has the role "main". Defaults: a partner counts as married and not same-sex unless stated; a child under 18 counts as dependent. Nationalities and country of birth are relevant for every person in the list (partner, children, parents), not only for the main applicant, because exclusions apply per person. | |
| program | Yes | Programme key: sao_tome (Sao Tome and Principe), vanuatu, dominica, st_lucia (Saint Lucia), st_kitts (St. Kitts and Nevis), grenada, antigua (Antigua and Barbuda), nauru, argentina. | |
| language | No | Response language: "en" (English, default) or "de" (German). | en |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| program | Yes | ||
| language | Yes | ||
| programLabel | No | ||
| quoteRequestUrl | Yes | Link to the calculator page with the family filled in, where the user enters their contact details and requests the detailed cost breakdown by e-mail. |