Get campaign execution history

GET

/v1/dunning_campaigns/{campaign_id}/execution_history

Get payment requests generated by this campaign with customer and invoice details.

Parameters

Path Parameters

campaign_id

required

Campaign Id

string format: uuid

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 100 >= 1 <= 1000

Responses

200

Successful Response

Response Get Execution History V1 Dunning Campaigns Campaign Id Execution History Get

Array<object>

ExecutionHistoryEntry

A single payment request in the campaign’s execution history.

object

id

required

Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

customer_name

Any of:

string

string

null

null

amount_cents

required

Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

amount_currency

required

Amount Currency

string

payment_status

required

Payment Status

string

payment_attempts

required

Payment Attempts

integer

ready_for_payment_processing

required

Ready For Payment Processing

boolean

invoices

Invoices

Array<object>

ExecutionHistoryInvoice

Invoice summary within an execution history entry.

object

id

required

Id

string format: uuid

invoice_number

required

Invoice Number

string

amount_cents

required

Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Dunning campaign not found

422

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