Retrieve Catalog Eligibility

Returns every item in your catalog that can be charged to an HSA/FSA card, with no customer in context.

This is catalog eligibility — a property of the product. An item appears here when its eligibility category is HSA/FSA-payable for your merchant account, whether it requires a Letter of Medical Necessity or is pre-approved and requires none. It is the widest possible answer: everything a customer could be eligible for, before anyone has qualified.

Whether a particular customer can put one of these items on their HSA/FSA card is a separate question — customer eligibility — answered by the keyed forms of this endpoint. Use this form to mark eligible items wherever you present your catalog, and a keyed form once you know who is shopping.

Because no customer is identified, eligibility_status and lmn_expires_at are both null. Nothing in the response depends on a customer, so it is safe to cache for as long as your catalog is stable.

Returns every item in your catalog that can be charged to an HSA/FSA card, with no customer in context. This is **catalog eligibility** — a property of the product. An item appears here when its eligibility category is HSA/FSA-payable for your merchant account, whether it requires a Letter of Medical Necessity or is pre-approved and requires none. It is the widest possible answer: everything a customer *could* be eligible for, before anyone has qualified. Whether a *particular* customer can put one of these items on their HSA/FSA card is a separate question — **customer eligibility** — answered by the keyed forms of this endpoint. Use this form to mark eligible items wherever you present your catalog, and a keyed form once you know who is shopping. Because no customer is identified, `eligibility_status` and `lmn_expires_at` are both null. Nothing in the response depends on a customer, so it is safe to cache for as long as your catalog is stable.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Response

Successful response

itemslist of strings

The catalog items that can be charged to an HSA/FSA card, each identified exactly as it is in order_items when you charge.

eligibility_statusenum or nullOptional

Where this customer’s clinical eligibility stands. Named apart from the payment status on other Truemed payloads, which is a different vocabulary. Per-value meanings are listed on the enum. Null for catalog eligibility, which identifies no customer.

One of:

approved — A verified, unexpired letter stands for this customer.
pending — A survey is with a clinician; the outcome is not decided yet.
expired — The letter that covered this customer has lapsed and not been renewed.
rejected — A clinician reviewed this customer’s most recent survey and declined it.
never_requested — No letter has ever been requested for this customer here.

lmn_expires_atdatetime or nullOptional

When the letter determining this customer’s coverage expires: in the future while approved, in the past once expired. Null for catalog eligibility, which identifies no customer.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

501

Not Implemented Error

Returns every item in your catalog that can be charged to an HSA/FSA card, with no customer in context.

1	{
2	"items": [
3	"string"
4	],
5	"eligibility_status": "approved",
6	"lmn_expires_at": "2024-01-15T09:30:00Z"
7	}