provider

inventory

Get Membership

Get a specific membership by ID.

get/inventory/memberships/{membership_id}

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/memberships/:membership_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

membership_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

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

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

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 operation across all 2 revisions of this API.