Switch Membership

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

import requests

url = "https://api.decodahealth.com/inventory/members/switch"

payload = {
    "memberId": "<string>",
    "newMembershipId": "<string>",
    "switchDate": "2023-11-07T05:31:56Z",
    "firstBillingDate": "2023-11-07T05:31:56Z",
    "paymentMethodId": "<string>",
    "soldByProviderId": "<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({
    memberId: '<string>',
    newMembershipId: '<string>',
    switchDate: '2023-11-07T05:31:56Z',
    firstBillingDate: '2023-11-07T05:31:56Z',
    paymentMethodId: '<string>',
    soldByProviderId: '<string>'
  })
};

fetch('https://api.decodahealth.com/inventory/members/switch', 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/switch",
  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([
    'memberId' => '<string>',
    'newMembershipId' => '<string>',
    'switchDate' => '2023-11-07T05:31:56Z',
    'firstBillingDate' => '2023-11-07T05:31:56Z',
    'paymentMethodId' => '<string>',
    'soldByProviderId' => '<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/switch"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<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/switch")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/inventory/members/switch")

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  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<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,
    "automaticallySendReceipts": false,
    "minimumBillingCycles": 0,
    "earlyCancellationFee": 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>",
      "defaultSendingText": "<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>",
    "preferredName": "<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>",
    "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",
  "cancellationDate": "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>",
  "switchedToMemberId": "<string>",
  "switchedFromMemberId": "<string>",
  "logs": [
    {
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}

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

POST

inventory

members

switch

Switch Membership

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

import requests

url = "https://api.decodahealth.com/inventory/members/switch"

payload = {
    "memberId": "<string>",
    "newMembershipId": "<string>",
    "switchDate": "2023-11-07T05:31:56Z",
    "firstBillingDate": "2023-11-07T05:31:56Z",
    "paymentMethodId": "<string>",
    "soldByProviderId": "<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({
    memberId: '<string>',
    newMembershipId: '<string>',
    switchDate: '2023-11-07T05:31:56Z',
    firstBillingDate: '2023-11-07T05:31:56Z',
    paymentMethodId: '<string>',
    soldByProviderId: '<string>'
  })
};

fetch('https://api.decodahealth.com/inventory/members/switch', 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/switch",
  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([
    'memberId' => '<string>',
    'newMembershipId' => '<string>',
    'switchDate' => '2023-11-07T05:31:56Z',
    'firstBillingDate' => '2023-11-07T05:31:56Z',
    'paymentMethodId' => '<string>',
    'soldByProviderId' => '<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/switch"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<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/switch")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/inventory/members/switch")

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  \"memberId\": \"<string>\",\n  \"newMembershipId\": \"<string>\",\n  \"switchDate\": \"2023-11-07T05:31:56Z\",\n  \"firstBillingDate\": \"2023-11-07T05:31:56Z\",\n  \"paymentMethodId\": \"<string>\",\n  \"soldByProviderId\": \"<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,
    "automaticallySendReceipts": false,
    "minimumBillingCycles": 0,
    "earlyCancellationFee": 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>",
      "defaultSendingText": "<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>",
    "preferredName": "<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>",
    "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",
  "cancellationDate": "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>",
  "switchedToMemberId": "<string>",
  "switchedFromMemberId": "<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

memberId

string

required

ID of the member to switch to a different plan

newMembershipId

string

required

ID of the membership plan to switch the member to

switchDate

string<date-time> | null

When to apply the switch (if None or today, switches immediately)

firstBillingDate

string<date-time> | null

When the new plan's first charge should occur (defaults to one billing cycle after the switch)

paymentMethodId

string | null

Payment method for the new plan (defaults to the member's current one)

soldByProviderId

string | null

Provider credited for the switch

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,

SWITCHED

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

cancellationDate

string<date-time> | null

When the membership should be automatically cancelled

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.

switchedToMemberId

string | null

If this enrollment was switched to another plan, the new member row it became.

switchedFromMemberId

string | null

If this enrollment was created by a plan switch, the prior member row it replaced.

logs

MemberLogTiny · object[]

Activity logs for this member

Show child attributes

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Communications

Platform

Switch Membership

Headers

Body

Response