Sign in
Policies

Get Policy

get/v1/policies/{policy_id}

Path parameters

policy_idinteger required

Policy id

Policy id

Response

Successful Response

idstring required
codestring required
effectivestring date
cancel_datestring date
enrollment_datestring date
enrollment_reasonstring
submittedstring date-time
sale_typestring
plan_idstring
plan_namestring
marketplace_idstring
ffmstring
npnstring
premiumnumber
total_costnumber
subsidynumber
household_incomenumber
qty_membersinteger
qty_applicantsinteger
qty_dependentsinteger
payment_statusstring

pending | auto-pay | failed | paid | not-applicable

documents_statusstring

pending | processing | declined | completed | expired

payment_first_datestring date
payment_dayinteger
payment_recurrentboolean
pending_renewalboolean
archived_atstring date-time
medicinesstring
primary_doctorstring
notesstring
createdstring date-time required
last_updatestring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.