Skip to main content
PUT
/
billing
/
invoice
/
retry-method
Retry Method
curl --request PUT \
  --url https://api.decodahealth.com/billing/invoice/retry-method \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "invoiceSetId": "<string>",
  "method": "CHARGE_CARD"
}
'
[
  {
    "id": "<string>",
    "status": "PENDING",
    "amount": 123,
    "methodsAttempted": [
      "<array>"
    ],
    "method": "CHARGE_CARD",
    "rule": {
      "id": "<string>",
      "name": "<string>",
      "methods": [
        "CHARGE_CARD"
      ],
      "delayInDays": 123,
      "message": "<string>"
    },
    "sendTime": "2023-11-07T05:31:56Z",
    "pausedDate": "2023-11-07T05:31:56Z",
    "resumedDate": "2023-11-07T05:31:56Z",
    "failedReason": "<string>",
    "pdfPath": "<string>",
    "emailStatus": "<string>",
    "smsContent": "<string>",
    "callStatus": "<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
invoiceSetId
string
required
method
enum<string>
required

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY

Response

Successful Response

id
string
required
status
enum<string>
required

The status of an invoice.

Available options:
PENDING,
SENT,
FAILED,
PAUSED,
CANCELLED
amount
integer
required
methodsAttempted
array[]
required
Required array length: 3 elements
method
enum<string> | null

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY
rule
RuleDetails · object
sendTime
string<date-time> | null
pausedDate
string<date-time> | null
resumedDate
string<date-time> | null
failedReason
string | null
pdfPath
string | null
emailStatus
string | null
smsContent
string | null
callStatus
string | null