Skip to main content

DunningCaseWithEvents

case objectrequired
amountAtRiskinteger<int64>required
closedAtstring<date-time>nullable
createdAtstring<date-time>nullable
currencystringrequired
customerIdstringrequired
declineCategorystringnullable
hostedSetupIntentIdstringnullable
idstringrequired
merchantIdstringrequired
nextActionstringnullable

MERCHANT_RETRY: one explicit retry with openedCycle/retryCount as the exact selector; never automatic.

nextActionAtstring<date-time>nullable
notesstringnullable
openedCycleinteger<int32>required
organizationIdstringnullable
recoveredAtstring<date-time>nullable
recoveryMethodstringnullable
retryCountinteger<int32>required
statusstringrequired

Case lifecycle. MERCHANT_RETRY_AVAILABLE is open: automatic retries stopped, but the merchant may retry or cancel.

subscriptionIdstringrequired
updatedAtstring<date-time>nullable
events object[]required
  • Array [
  • billingEventIdstringnullable
    caseIdstringrequired
    createdAtstring<date-time>nullable
    declineCategorystringnullable
    detail objectnullable
    property name*anynullable
    eventTypestringrequired
    idstringrequired
  • ]
  • timelineSelector objectnullable
    attemptinteger<int32>required
    cycleinteger<int32>required
    subscriptionIdstringrequired
    DunningCaseWithEvents
    {
    "case": {
    "amountAtRisk": 0,
    "closedAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "currency": "string",
    "customerId": "string",
    "declineCategory": "string",
    "hostedSetupIntentId": "string",
    "id": "string",
    "merchantId": "string",
    "nextAction": "string",
    "nextActionAt": "2024-07-29T15:51:28.071Z",
    "notes": "string",
    "openedCycle": 0,
    "organizationId": "string",
    "recoveredAt": "2024-07-29T15:51:28.071Z",
    "recoveryMethod": "string",
    "retryCount": 0,
    "status": "string",
    "subscriptionId": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    },
    "events": [
    {
    "billingEventId": "string",
    "caseId": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "declineCategory": "string",
    "detail": {},
    "eventType": "string",
    "id": "string"
    }
    ],
    "timelineSelector": {
    "attempt": 0,
    "cycle": 0,
    "subscriptionId": "string"
    }
    }