Skip to main content
GET
List Sonny's 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.

Query Parameters

customerId
string
billingSiteCode
string
creationSiteCode
string
status
string
planName
string
isOnTrial
boolean

Filter trial accounts.

isSuspended
boolean

Filter suspended accounts.

lastBillAfter
string<date-time>

Inclusive last-bill lower bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

lastBillBefore
string<date-time>

Inclusive last-bill upper bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

nextBillAfter
string<date-time>

Inclusive next-bill lower bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

nextBillBefore
string<date-time>

Inclusive next-bill upper bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

limit
integer
default:100

Page size. Invalid values use 100; values above 500 are capped at 500.

Required range: 1 <= x <= 500
cursor
string

Opaque continuation token returned by this Sonny's recurring account details collection. Cursors are bound to this endpoint (and, for nested or sorted collections, to that parent or sort) and cannot be reused elsewhere.

Response

Tenant-scoped collection.

Standard envelope for canonical collection endpoints.

organizationId
string
required
filters
object
required

Normalized filters actually applied to the request.

data
object[]
required
pagination
object
required