Skip to main content
GET
Get Payment Milestones

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

id
string
required

Stable resource identifier.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Visible entity.

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
agreementId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
sequence
number
required
label
string
required
basis
string
required
percent
string | null
required
fixedAmount
string | null
required
triggerEvent
string
required
offsetDays
number
required
manualDate
string | null
required
createdAt
string
required
updatedAt
string
required