Enroll Member Deferred Billing

Enroll a new member with deferred billing - they get benefits immediately but aren't charged until the specified date.

post/inventory/members/enroll-deferred

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/inventory/members/enroll-deferred/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

patientIdstring required

ID of the patient to enroll

membershipIdstring required

ID of the membership to enroll in

paymentMethodIdstring nullable

ID of the payment method to use for future billing (not required for $0 memberships)

firstBillingDatestring date-time required

Date when the first billing should occur

startDatestring date-time nullable

Start date for the membership (defaults to now)

soldByProviderIdstring nullable

ID of the provider who sold this membership

Response

Successful Response

idstring required

Unique identifier for the member

patientIdstring required

ID of the patient

membershipIdstring required

ID of the membership

soldByProviderIdstring nullable

ID of the provider who sold this membership

startDatestring date-time required

When the patient joined the membership

endDatestring date-time nullable

When the membership ended (if applicable)

nextBillingDatestring date-time nullable

Next scheduled billing date (if custom)

unfreezeDatestring date-time nullable

When the membership should be automatically unfrozen

status'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'DELINQUENT' | 'FROZEN' required

autoRenewboolean required

Whether the membership auto-renews

createdDatestring date-time nullable

When the member record was created

updatedDatestring date-time nullable

When the member record was last updated

Changes

No recorded changes to this operation across all 2 revisions of this API.