Create Membership

Patients synced from a network cannot be enrolled by the affiliate practice: creating a membership for one
returns 409 "This patient is synced from a Network". Contact the network to enroll them.

Body Params
membership_patients
array of objects
required

Members can be used as an alias for membership_patients

membership_patients*
plan
object
required
owner
object
sponsorship
object
date
required

Sponsored memberships must start on the 1st of the month. Retail memberships may start any day. Date must be formatted as YYYY-MM-DD.

date

Date must be formatted as YYYY-MM-DD.

int32
enum
required

Billing period in months. 1 = monthly, 3 = quarterly, 6 = semi-annually, 12 = annually

Allowed:
int32
int32
boolean

Defaults to true. Send false to create the membership as unconfirmed: it is not billed and stays in the "unconfirmed" status until it is confirmed with the Confirm Membership endpoint. The patient is not emailed about an unconfirmed membership at creation; the membership created email is sent when it is confirmed. Practices in a network that requires affiliates to confirm memberships always create them unconfirmed, so the is_confirmed value in the response can differ from the value sent.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json