Get dunning campaign

GET

/v1/dunning_campaigns/{campaign_id}

Get a dunning campaign by ID.

Parameters

Path Parameters

campaign_id

required

Campaign Id

string format: uuid

Responses

200

Successful Response

DunningCampaignResponse

Schema for dunning campaign response.

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

code

required

Code

string

name

required

Name

string

description

Any of:

string

string

null

null

max_attempts

required

Max Attempts

integer

days_between_attempts

required

Days Between Attempts

integer

bcc_emails

required

Bcc Emails

Array<string>

status

required

Status

string

thresholds

Thresholds

Array<object>

DunningCampaignThresholdResponse

Schema for dunning campaign threshold response.

object

id

required

Id

string format: uuid

dunning_campaign_id

required

Dunning Campaign Id

string format: uuid

currency

required

Currency

string

amount_cents

required

Amount Cents

string

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

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

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