Skip to main content
POST
/
inventory
/
members
/
update-payment-method
Update Payment Method
curl --request POST \
  --url https://api.decodahealth.com/inventory/members/update-payment-method \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "memberId": "<string>",
  "paymentMethodId": "<string>",
  "comment": "<string>",
  "chargeImmediately": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 update the payment method for

paymentMethodId
string
required

New payment method ID

comment
string | null

Comment explaining the payment method change

chargeImmediately
boolean
default:false

Whether to immediately attempt to charge the member if they are delinquent

Response

Successful Response