Skip to content

Get campaign timeline

GET
/v1/dunning_campaigns/{campaign_id}/timeline

Get a chronological timeline of campaign events and outcomes.

campaign_id
required
Campaign Id
string format: uuid

Successful Response

CampaignTimelineResponse

Chronological timeline of campaign events.

object
events
Events
Array<object>
CampaignTimelineEvent

A single event in the campaign timeline.

object
event_type
required
Event Type
string
timestamp
required
Timestamp
string format: date-time
description
required
Description
string
payment_request_id
Any of:
string format: uuid
customer_name
Any of:
string
amount_cents
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
Any of:
string
payment_status
Any of:
string
attempt_number
Any of:
integer

Unauthorized

Dunning campaign not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object