Skip to main content
GET
Get POS recurring account details

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Path Parameters

accountId
string
required

Response

Tenant-scoped resource.

id
string
required
billingAmountCents
integer | null
required

Amount in integer cents.

billingSiteCode
string | null
required
creationSiteCode
string | null
required
currentRecurringStatusName
string | null
required
customer
object | null
required
isOnTrial
boolean | null
required
isSuspended
boolean | null
required
lastBillDate
string<date-time> | null
required

UTC ISO 8601 timestamp.

nextBillDate
string<date-time> | null
required

UTC ISO 8601 timestamp.

planName
string | null
required
recurringBillings
object[]
required

Recent billing history; shared POS mirrors return at most the latest 24 events, newest first.

recurringStatuses
object[]
required

Recent status history; shared POS mirrors return at most the latest 24 events, newest first.

suspendedUntil
string<date-time> | null
required

UTC ISO 8601 timestamp.

trialAmountCents
integer | null
required

Amount in integer cents.

vehicles
object[]
required