provider
inventory

Create Membership

Create a new membership.

post/inventory/memberships

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring

Unique identifier for the membership

externalIdstring nullable

External system identifier for the membership

namestring required

Name of the membership

descriptionstring nullable

Optional description of the membership

priceinteger required

Price of the membership in cents

globalDiscountPercentagenumber nullable

Global discount percentage for all items

patientCreditAmountinteger

Amount of patient credit in cents

patientCreditFrequency'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'YEARLY'
patientCreditExpiryDaysinteger nullable

Days until patient credit expires

maxRenewalsinteger nullable

Maximum number of renewals (null means unlimited)

autoRenewboolean

Whether the membership auto-renews

setupFeeinteger

Setup fee for the membership in cents

freezeFeeinteger

Fee to freeze the membership in cents

minimumBillingCyclesinteger

Minimum number of billing cycles required

billingFrequency'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'YEARLY'
textColorstring nullable

Text color for the membership

isArchivedboolean

Whether the membership is archived

ruleSetIdstring nullable

ID of the rule set for the membership

memberCountinteger nullable

Number of active members

totalRevenueinteger nullable

Total revenue from this membership

Response

Successful Response

idstring

Unique identifier for the membership

externalIdstring nullable

External system identifier for the membership

namestring required

Name of the membership

descriptionstring nullable

Optional description of the membership

priceinteger required

Price of the membership in cents

globalDiscountPercentagenumber nullable

Global discount percentage for all items

patientCreditAmountinteger

Amount of patient credit in cents

patientCreditFrequency'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'YEARLY'
patientCreditExpiryDaysinteger nullable

Days until patient credit expires

maxRenewalsinteger nullable

Maximum number of renewals (null means unlimited)

autoRenewboolean

Whether the membership auto-renews

setupFeeinteger

Setup fee for the membership in cents

freezeFeeinteger

Fee to freeze the membership in cents

minimumBillingCyclesinteger

Minimum number of billing cycles required

billingFrequency'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'YEARLY'
textColorstring nullable

Text color for the membership

isArchivedboolean

Whether the membership is archived

ruleSetIdstring nullable

ID of the rule set for the membership

memberCountinteger nullable

Number of active members

totalRevenueinteger nullable

Total revenue from this membership

Changes

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