List Membership Usage

curl --request GET \
  --url https://api.decodahealth.com/inventory/memberships/{membership_id}/usage \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "membershipId": "<string>",
      "membership": {
        "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
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "autoRenew": true,
      "billingFrequency": "DAILY",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      },
      "charges": [
        {
          "id": "<string>",
          "patientId": "<string>"
        }
      ],
      "soldByProviderId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "nextBillingDate": "2023-11-07T05:31:56Z",
      "unfreezeDate": "2023-11-07T05:31:56Z",
      "soldByProvider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "paymentMethod": {
        "id": "<string>",
        "patientId": "<string>",
        "rainforestPaymentMethodId": "<string>",
        "brand": "<string>",
        "last4": "<string>",
        "expMonth": 123,
        "expYear": 123,
        "accountHolderType": "<string>",
        "accountNumberLast4": 123,
        "bankName": "<string>",
        "routingNumber": 123,
        "description": "<string>",
        "type": "CARD",
        "isDefault": false,
        "isArchived": false
      },
      "logs": [
        {
          "id": "<string>",
          "logType": "STATUS_CHANGE",
          "createdDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "total": 123
}

GET

inventory

memberships

{membership_id}

usage

List Membership Usage

curl --request GET \
  --url https://api.decodahealth.com/inventory/memberships/{membership_id}/usage \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "membershipId": "<string>",
      "membership": {
        "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
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "autoRenew": true,
      "billingFrequency": "DAILY",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      },
      "charges": [
        {
          "id": "<string>",
          "patientId": "<string>"
        }
      ],
      "soldByProviderId": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "nextBillingDate": "2023-11-07T05:31:56Z",
      "unfreezeDate": "2023-11-07T05:31:56Z",
      "soldByProvider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "paymentMethod": {
        "id": "<string>",
        "patientId": "<string>",
        "rainforestPaymentMethodId": "<string>",
        "brand": "<string>",
        "last4": "<string>",
        "expMonth": 123,
        "expYear": 123,
        "accountHolderType": "<string>",
        "accountNumberLast4": 123,
        "bankName": "<string>",
        "routingNumber": 123,
        "description": "<string>",
        "type": "CARD",
        "isDefault": false,
        "isArchived": false
      },
      "logs": [
        {
          "id": "<string>",
          "logType": "STATUS_CHANGE",
          "createdDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

membership_id

string

required

Query Parameters

status

string | null

Filter by member status

name

string | null

Filter by patient name

start_date

string | null

Filter by start date

page

integer

default:1

Page number

per_page

integer

default:25

Items per page

sort_by

string

default:created_date

Sort by field

sort_direction

string

default:desc

Sort direction (asc/desc)

Response

Successful Response

data

MemberDetail · object[]

required

Show child attributes

data.id

string

required

Unique identifier for the member

data.patientId

string

required

ID of the patient

data.membershipId

string

required

ID of the membership

data.membership

MembershipDetail · object

required

Membership information

Show child attributes

data.membership.name

string

required

Name of the membership

data.membership.price

integer

required

Price of the membership in cents

data.membership.id

string

Unique identifier for the membership

data.membership.externalId

string | null

External system identifier for the membership

data.membership.description

string | null

Optional description of the membership

data.membership.globalDiscountPercentage

number | null

default:0

Global discount percentage for all items

data.membership.patientCreditAmount

integer

default:0

Amount of patient credit in cents

data.membership.patientCreditFrequency

enum<string>

default:MONTHLY

Frequency of patient credit

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

data.membership.patientCreditExpiryDays

integer | null

Days until patient credit expires

data.membership.maxRenewals

integer | null

default:0

Maximum number of renewals (null means unlimited)

data.membership.autoRenew

boolean

default:true

Whether the membership auto-renews

data.membership.setupFee

integer

default:0

Setup fee for the membership in cents

data.membership.freezeFee

integer

default:0

Fee to freeze the membership in cents

data.membership.minimumBillingCycles

integer

default:0

Minimum number of billing cycles required

data.membership.billingFrequency

enum<string>

default:MONTHLY

Billing frequency for the membership

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

data.membership.textColor

string | null

Text color for the membership

data.membership.isArchived

boolean

default:false

Whether the membership is archived

data.membership.ruleSetId

string | null

ID of the rule set for the membership

data.membership.discounts

MembershipDiscount · object[] | null

Optional discounts for the membership

Show child attributes

data.membership.discounts.membershipId

string

required

ID of the membership this discount belongs to

data.membership.discounts.id

string

Unique identifier for the membership discount

data.membership.discounts.itemId

string | null

ID of the specific item for this discount (includes packages)

data.membership.discounts.itemCategory

string | null

Category name for items in this discount (references category.name)

data.membership.discounts.isPhysical

boolean | null

Whether this discount applies to physical items (True), services (False), or neither (None)

data.membership.discounts.discountPercentage

number | null

Discount percentage

data.membership.discounts.discountAmount

integer | null

Discount amount in cents

data.membership.discounts.creditAmount

integer | null

Credit amount in cents

data.membership.discounts.quantity

integer | null

Quantity for this discount

data.membership.discounts.rollover

boolean

default:false

Whether to rollover unused quantities

data.membership.discounts.rolloverExpiryDays

integer | null

Days until rollover items expire

data.membership.discounts.neverExpire

boolean

default:false

Whether rollover items never expire

data.membership.discounts.group

string | null

Group for this discount

data.membership.discounts.isArchived

boolean

default:false

Whether the discount is archived

data.membership.memberCount

integer | null

default:0

Number of active members

data.membership.totalRevenue

integer | null

default:0

Total revenue from this membership

data.startDate

string<date-time>

required

When the patient joined the membership

data.status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

data.autoRenew

boolean

required

Whether the membership auto-renews

data.billingFrequency

enum<string>

required

Billing frequency for this member

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

YEARLY

data.patient

PatientSummary · object

required

Patient information

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.charges

ChargeTiny · object[]

required

Charges for this member

Show child attributes

data.charges.id

string

required

Unique identifier for the charge.

data.charges.patientId

string

required

Identifier of the patient being charged.

data.soldByProviderId

string | null

ID of the provider who sold this membership

data.endDate

string<date-time> | null

When the membership ended (if applicable)

data.nextBillingDate

string<date-time> | null

Next scheduled billing date (if custom)

data.unfreezeDate

string<date-time> | null

When the membership should be automatically unfrozen

data.soldByProvider

ProviderCreator · object

Provider who sold this membership

Show child attributes

data.soldByProvider.id

string

required

data.soldByProvider.firstName

string

required

data.soldByProvider.lastName

string | null

data.createdDate

string<date-time> | null

When the member record was created

data.updatedDate

string<date-time> | null

When the member record was last updated

data.paymentMethod

PaymentMethodSummary · object

Payment method for this member

Show child attributes

data.paymentMethod.id

string

required

data.paymentMethod.patientId

string | null

required

data.paymentMethod.rainforestPaymentMethodId

string

required

data.paymentMethod.brand

string | null

required

data.paymentMethod.last4

string | null

required

data.paymentMethod.expMonth

integer | null

required

data.paymentMethod.expYear

integer | null

required

data.paymentMethod.accountHolderType

string | null

required

data.paymentMethod.accountNumberLast4

integer | null

required

data.paymentMethod.bankName

string | null

required

data.paymentMethod.routingNumber

integer | null

required

data.paymentMethod.description

string | null

required

data.paymentMethod.type

enum<string> | null

required

Available options:

CARD,

ACH,

APPLE_PAY

data.paymentMethod.isDefault

boolean

default:false

data.paymentMethod.isArchived

boolean

default:false

data.logs

MemberLogTiny · object[]

Activity logs for this member

Show child attributes

data.logs.id

string

required

Unique identifier for the log

data.logs.logType

enum<string>

required

Type of log

Available options:

STATUS_CHANGE,

MANUAL_PAYMENT,

RENEWED,

PAYMENT_METHOD_CHANGE,

DISCOUNT_USED,

DISCOUNT_RESTORED,

DISCOUNT_MODIFIED,

ENROLLED,

BILLING_DATE_CHANGE

data.logs.createdDate

string<date-time>

required

When the log was created

total

integer

required

List Item List Memberships

⌘I

Getting Started

API

Tenant

Webhook

List Membership Usage

Headers

Path Parameters

Query Parameters

Response