curl --request GET \
--url https://api.decodahealth.com/inventory/memberships \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'{
"data": [
{
"name": "<string>",
"price": 123,
"id": "<string>",
"externalId": "<string>",
"description": "<string>",
"globalDiscountPercentage": 0,
"patientCreditAmount": 0,
"patientCreditFrequency": "MONTHLY",
"patientCreditExpiryDays": 123,
"maxRenewals": 0,
"autoRenew": true,
"setupFee": 0,
"freezeFee": 0,
"minimumBillingCycles": 0,
"billingFrequency": "MONTHLY",
"textColor": "<string>",
"isArchived": false,
"ruleSetId": "<string>",
"discounts": [
{
"membershipId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"isPhysical": true,
"discountPercentage": 123,
"discountAmount": 123,
"creditAmount": 123,
"quantity": 123,
"rollover": false,
"rolloverExpiryDays": 123,
"neverExpire": false,
"group": "<string>",
"isArchived": false
}
],
"memberCount": 0,
"totalRevenue": 0
}
],
"total": 123
}List all memberships with optional filtering.
curl --request GET \
--url https://api.decodahealth.com/inventory/memberships \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'{
"data": [
{
"name": "<string>",
"price": 123,
"id": "<string>",
"externalId": "<string>",
"description": "<string>",
"globalDiscountPercentage": 0,
"patientCreditAmount": 0,
"patientCreditFrequency": "MONTHLY",
"patientCreditExpiryDays": 123,
"maxRenewals": 0,
"autoRenew": true,
"setupFee": 0,
"freezeFee": 0,
"minimumBillingCycles": 0,
"billingFrequency": "MONTHLY",
"textColor": "<string>",
"isArchived": false,
"ruleSetId": "<string>",
"discounts": [
{
"membershipId": "<string>",
"id": "<string>",
"itemId": "<string>",
"itemCategory": "<string>",
"isPhysical": true,
"discountPercentage": 123,
"discountAmount": 123,
"creditAmount": 123,
"quantity": 123,
"rollover": false,
"rolloverExpiryDays": 123,
"neverExpire": false,
"group": "<string>",
"isArchived": false
}
],
"memberCount": 0,
"totalRevenue": 0
}
],
"total": 123
}The tenant you are making this request on behalf of
Your api key
Filter by membership name
Minimum price filter
Maximum price filter
Filter by archived status
Page number
Items per page
Successful Response
Show child attributes
Name of the membership
Price of the membership in cents
Unique identifier for the membership
External system identifier for the membership
Optional description of the membership
Global discount percentage for all items
Amount of patient credit in cents
Frequency of patient credit
DAILY, WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, YEARLY Days until patient credit expires
Maximum number of renewals (null means unlimited)
Whether the membership auto-renews
Setup fee for the membership in cents
Fee to freeze the membership in cents
Minimum number of billing cycles required
Billing frequency for the membership
DAILY, WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, YEARLY Text color for the membership
Whether the membership is archived
ID of the rule set for the membership
Optional discounts for the membership
Show child attributes
ID of the membership this discount belongs to
Unique identifier for the membership discount
ID of the specific item for this discount (includes packages)
Category name for items in this discount (references category.name)
Whether this discount applies to physical items (True), services (False), or neither (None)
Discount percentage
Discount amount in cents
Credit amount in cents
Quantity for this discount
Whether to rollover unused quantities
Days until rollover items expire
Whether rollover items never expire
Group for this discount
Whether the discount is archived
Number of active members
Total revenue from this membership