Skip to main content
POST
Restore a removed bill

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Path Parameters

billId
string
required

The bill ID

Response

Response for status 200

id
string
required

Unique identifier for the bill

status
enum<string>
required
Available options:
active,
pending,
inactive,
rejected,
action_required,
deleted
name
string
required

Provider bill name or generated fallback label

Example:

"Chase Sapphire Card"

type
enum<string>
required
Available options:
auto_loan,
credit_card,
loan,
mobile_phone,
mortgage,
student_loan,
utility,
unknown
currency
enum<string>
required
Available options:
USD,
CAD,
EUR,
GBP
createdAt
string<date-time>
required

When the bill was linked

institution
object

Financial institution details

accountNumberLast4
string

Last 4 digits of the bill account number

Example:

"1234"

liability
object

Liability data from the bill provider. All fields are optional and amounts are decimal strings.

requirements
object[]

Actions the user must complete before the bill is payable. Present (non-empty) when status is action_required.

unpayableCode
enum<string>
Available options:
institution_not_supported,
account_number_invalid,
account_verification_failed,
not_supported
deletedAt
string<date-time>

When the user removed the bill. Present only when status is deleted.