Enroll Member Awaiting Form

curl --request POST \
  --url https://api.decodahealth.com/inventory/members/enroll-awaiting-form \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientId": "<string>",
  "membershipId": "<string>",
  "firstBillingDate": "2023-11-07T05:31:56Z",
  "paymentMethodId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "soldByProviderId": "<string>",
  "soldAtLocationId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/inventory/members/enroll-awaiting-form"

payload = {
    "patientId": "<string>",
    "membershipId": "<string>",
    "firstBillingDate": "2023-11-07T05:31:56Z",
    "paymentMethodId": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "soldByProviderId": "<string>",
    "soldAtLocationId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    patientId: '<string>',
    membershipId: '<string>',
    firstBillingDate: '2023-11-07T05:31:56Z',
    paymentMethodId: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    soldByProviderId: '<string>',
    soldAtLocationId: '<string>'
  })
};

fetch('https://api.decodahealth.com/inventory/members/enroll-awaiting-form', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/inventory/members/enroll-awaiting-form",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'patientId' => '<string>',
    'membershipId' => '<string>',
    'firstBillingDate' => '2023-11-07T05:31:56Z',
    'paymentMethodId' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'soldByProviderId' => '<string>',
    'soldAtLocationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/inventory/members/enroll-awaiting-form"

	payload := strings.NewReader("{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/inventory/members/enroll-awaiting-form")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/inventory/members/enroll-awaiting-form")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "patientId": "<string>",
  "membershipId": "<string>",
  "membership": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "externalId": "<string>",
    "description": "<string>",
    "patientCreditAmount": 0,
    "patientCreditFrequency": "MONTHLY",
    "patientCreditExpiryDays": 123,
    "maxRenewals": 0,
    "autoRenew": true,
    "setupFee": 0,
    "freezeFee": 0,
    "applySurcharge": false,
    "minimumBillingCycles": 0,
    "billingFrequency": "MONTHLY",
    "benefitType": "PREPAYMENT_DISCOUNT",
    "recognitionMode": "CASH",
    "expectedUsesPerCycle": 1,
    "textColor": "<string>",
    "isArchived": false,
    "commissionable": true,
    "hiddenInPatientPortal": false,
    "ruleSetId": "<string>",
    "formId": "<string>",
    "form": {
      "name": "<string>",
      "pathName": "<string>"
    },
    "merchantAccountId": "<string>",
    "depositStrategy": "MEMBERSHIP_ACCOUNT",
    "feeSchedule": [
      {
        "cycleNumber": 2,
        "price": 1,
        "id": "<string>",
        "membershipId": ""
      }
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "discountTemplates": [
      {
        "id": "<string>",
        "createdByItemId": "<string>",
        "discountChoiceId": "<string>",
        "itemId": "<string>",
        "category": "<string>",
        "percentage": 123,
        "amount": 123,
        "quantity": 123,
        "expiryTimeDays": 123,
        "renewalCycleInterval": 2,
        "isStackable": true,
        "isPrepayment": false,
        "group": "<string>",
        "isArchived": false,
        "createdDate": "2023-11-07T05:31:56Z",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "memberCount": 0,
    "totalRevenue": 0
  },
  "startDate": "2023-11-07T05:31:56Z",
  "autoRenew": true,
  "patient": {
    "id": "<string>",
    "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>",
    "pronouns": "<string>",
    "preferredName": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "leadSource": "<string>",
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "optedInToSmsMarketing": true,
    "optedInToEmailMarketing": true,
    "optedInToSocialMedia": true,
    "aiScribeConsent": 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>",
    "dosespotPatientId": "<string>"
  },
  "charges": [
    {
      "id": "<string>",
      "patientId": "<string>"
    }
  ],
  "soldByProviderId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "freezeDate": "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>",
    "isDefault": false,
    "isArchived": false,
    "availableMerchantIds": [
      "<string>"
    ],
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "merchantAccountId": "<string>",
  "soldAtLocationId": "<string>",
  "logs": [
    {
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

inventory

members

enroll-awaiting-form

Enroll Member Awaiting Form

curl --request POST \
  --url https://api.decodahealth.com/inventory/members/enroll-awaiting-form \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientId": "<string>",
  "membershipId": "<string>",
  "firstBillingDate": "2023-11-07T05:31:56Z",
  "paymentMethodId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "soldByProviderId": "<string>",
  "soldAtLocationId": "<string>"
}
'

import requests

url = "https://api.decodahealth.com/inventory/members/enroll-awaiting-form"

payload = {
    "patientId": "<string>",
    "membershipId": "<string>",
    "firstBillingDate": "2023-11-07T05:31:56Z",
    "paymentMethodId": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "soldByProviderId": "<string>",
    "soldAtLocationId": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    patientId: '<string>',
    membershipId: '<string>',
    firstBillingDate: '2023-11-07T05:31:56Z',
    paymentMethodId: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    soldByProviderId: '<string>',
    soldAtLocationId: '<string>'
  })
};

fetch('https://api.decodahealth.com/inventory/members/enroll-awaiting-form', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/inventory/members/enroll-awaiting-form",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'patientId' => '<string>',
    'membershipId' => '<string>',
    'firstBillingDate' => '2023-11-07T05:31:56Z',
    'paymentMethodId' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'soldByProviderId' => '<string>',
    'soldAtLocationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/inventory/members/enroll-awaiting-form"

	payload := strings.NewReader("{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/inventory/members/enroll-awaiting-form")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/inventory/members/enroll-awaiting-form")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientId\": \"<string>\",\n  \"membershipId\": \"<string>\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"soldByProviderId\": \"<string>\",\n  \"soldAtLocationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "patientId": "<string>",
  "membershipId": "<string>",
  "membership": {
    "name": "<string>",
    "price": 123,
    "id": "<string>",
    "externalId": "<string>",
    "description": "<string>",
    "patientCreditAmount": 0,
    "patientCreditFrequency": "MONTHLY",
    "patientCreditExpiryDays": 123,
    "maxRenewals": 0,
    "autoRenew": true,
    "setupFee": 0,
    "freezeFee": 0,
    "applySurcharge": false,
    "minimumBillingCycles": 0,
    "billingFrequency": "MONTHLY",
    "benefitType": "PREPAYMENT_DISCOUNT",
    "recognitionMode": "CASH",
    "expectedUsesPerCycle": 1,
    "textColor": "<string>",
    "isArchived": false,
    "commissionable": true,
    "hiddenInPatientPortal": false,
    "ruleSetId": "<string>",
    "formId": "<string>",
    "form": {
      "name": "<string>",
      "pathName": "<string>"
    },
    "merchantAccountId": "<string>",
    "depositStrategy": "MEMBERSHIP_ACCOUNT",
    "feeSchedule": [
      {
        "cycleNumber": 2,
        "price": 1,
        "id": "<string>",
        "membershipId": ""
      }
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "discountTemplates": [
      {
        "id": "<string>",
        "createdByItemId": "<string>",
        "discountChoiceId": "<string>",
        "itemId": "<string>",
        "category": "<string>",
        "percentage": 123,
        "amount": 123,
        "quantity": 123,
        "expiryTimeDays": 123,
        "renewalCycleInterval": 2,
        "isStackable": true,
        "isPrepayment": false,
        "group": "<string>",
        "isArchived": false,
        "createdDate": "2023-11-07T05:31:56Z",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "memberCount": 0,
    "totalRevenue": 0
  },
  "startDate": "2023-11-07T05:31:56Z",
  "autoRenew": true,
  "patient": {
    "id": "<string>",
    "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>",
    "pronouns": "<string>",
    "preferredName": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "leadSource": "<string>",
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "optedInToSmsMarketing": true,
    "optedInToEmailMarketing": true,
    "optedInToSocialMedia": true,
    "aiScribeConsent": 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>",
    "dosespotPatientId": "<string>"
  },
  "charges": [
    {
      "id": "<string>",
      "patientId": "<string>"
    }
  ],
  "soldByProviderId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "freezeDate": "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>",
    "isDefault": false,
    "isArchived": false,
    "availableMerchantIds": [
      "<string>"
    ],
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "merchantAccountId": "<string>",
  "soldAtLocationId": "<string>",
  "logs": [
    {
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Body

application/json

Schema for saving a member while their enrollment form is completed async.

patientId

string

required

ID of the patient to enroll

membershipId

string

required

ID of the membership to enroll in

firstBillingDate

string<date-time>

required

Date when the first billing should occur

paymentMethodId

string | null

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

startDate

string<date-time> | null

Start date for the membership (defaults to now)

soldByProviderId

string | null

ID of the provider who sold this membership

soldAtLocationId

string | null

Location where this enrollment was sold; drives LOCATION_ACCOUNT deposit routing

Response

Successful Response

string

required

Unique identifier for the member

patientId

string

required

ID of the patient

membershipId

string

required

ID of the membership

membership

MembershipDetail · object

required

Membership information

Show child attributes

startDate

string<date-time>

required

When the patient joined the membership

status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN,

INACTIVE,

PENDING,

AWAITING_FORM

autoRenew

boolean

required

Whether the membership auto-renews

billingFrequency

enum<string>

required

Billing frequency for this member

Available options:

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

EVERY_FOUR_WEEKS,

EVERY_SIX_WEEKS,

EVERY_TEN_WEEKS,

EVERY_TWELVE_WEEKS,

QUARTERLY,

EVERY_FOUR_MONTHS,

SEMI_ANNUALLY,

YEARLY

patient

PatientSummary · object

required

Patient information

Show child attributes

charges

ChargeTinyWebhook · object[]

required

Charges for this member

Show child attributes

soldByProviderId

string | null

ID of the provider who sold this membership

endDate

string<date-time> | null

When the membership ended (if applicable)

nextBillingDate

string<date-time> | null

Next scheduled billing date (if custom)

freezeDate

string<date-time> | null

When the membership should be automatically frozen

unfreezeDate

string<date-time> | null

When the membership should be automatically unfrozen

soldByProvider

ProviderCreator · object | null

Provider who sold this membership

Show child attributes

createdDate

string<date-time> | null

When the member record was created

updatedDate

string<date-time> | null

When the member record was last updated

paymentMethod

PaymentMethodSummary · object | null

Payment method for this member

Show child attributes

merchantAccountId

string | null

Per-member deposit account override. When set, billing routes here regardless of the membership's deposit_strategy. Null = no override (resolve via plan strategy).

soldAtLocationId

string | null

Location where this member was enrolled. Snapshotted from the originating charge; used to resolve deposits when the membership's deposit_strategy is LOCATION_ACCOUNT.

logs

MemberLogTiny · object[]

Activity logs for this member

Show child attributes

Duplicate Membership Enroll Member Deferred Billing

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Platform

Enroll Member Awaiting Form

Headers

Body

Response