Skip to main content
GET
Get a recurring charge series

Authorizations

Authorization
string
header
required

Use Authorization: Bearer esk_live_... or esk_test_... for API access

Path Parameters

id
string
required

Response

id
string<uuid>
required
clientId
string<uuid>
required
organizationId
string<uuid>
required
productName
string
required
amount
number
required
frequency
string
required
Example:

"monthly"

dayOfMonth
number
required
startDate
string
required
Example:

"2026-03-15"

occurrenceCount
number
required
nextDueDate
string
required
nextRunAt
string
required
status
enum<string>
required
Available options:
active,
paused,
cancelled,
completed
createdAt
object
required
updatedAt
object
required
endDate
object | null
maxOccurrences
object | null