Generated by API Evangelist
Written by API Evangelist tooling for Hint Health's API. It is a proposal applied on top of the contract, not a document Hint Health publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Hint Health Membership Contract API
version: 1.0.0
extends: openapi/hint-health-membershipcontract-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/provider/memberships/{membership_id}/contracts'].get
update:
x-apievangelist-phrasing:
intent: List a membership's contracts
effect: read
questions:
- Which contract terms has a membership gone through?
- What is the contract history for one membership?
instructions:
- text: List contracts for membership {membership_id}.
slots:
membership_id: path.membership_id
- text: Show every contract term on membership {membership_id}.
slots:
membership_id: path.membership_id
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/contracts/renew'].post
update:
x-apievangelist-phrasing:
intent: Renew a membership contract
effect: write
questions:
- Can I renew a membership contract for another term?
- Can I add a memo when renewing a membership contract?
instructions:
- text: Renew the contract on membership {membership_id}.
slots:
membership_id: path.membership_id
- text: Renew membership {membership_id}'s contract with memo {memo}.
slots:
membership_id: path.membership_id
memo: requestBody.memo
method: generated
generated: '2026-10-01'
- target: $.paths['/provider/memberships/{membership_id}/contracts/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Change a contract's end or billing end date
effect: write
questions:
- How do I change the end date of a membership contract?
- Can I set a billing end date that differs from the contract end date?
instructions:
- text: Set the end date of contract {id} on membership {membership_id} to {end_date}.
slots:
id: path.id
membership_id: path.membership_id
end_date: requestBody.end_date
- text: Change the billing end date of contract {id} on membership {membership_id} to {billing_end_date}.
slots:
id: path.id
membership_id: path.membership_id
billing_end_date: requestBody.billing_end_date
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.