Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Recurring charge

List recurring charge suggestions

Returns a paginated list of pending, auto-detected recurring-charge suggestions for the company, ordered by detection confidence (descending). Each suggestion includes its merchant and vendor_card summaries. Non-admin callers see suggestions for their cards or user, or all company suggestions if they hold card_transactions_manage.

get/v1/recurring_charge_suggestions

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring
Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

merchant_idstring uuid

Filter by merchant.

Headers

company-idstring uuid required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Response

Paginated list of pending suggestions

idstring uuid required
company_idstring uuid required
merchant_idstring uuid required
vendor_card_idstring nullable
user_idstring nullable
amount_centsinteger required
currencystring required
frequency'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual' required
confidence_scorestring

Detection confidence (0-100).

status'pending' | 'confirmed' | 'dismissed' required
supporting_transaction_idsstring[]

Ids of the card transactions that support the detection.

detection_metadataobject
first_transaction_atstring date-time nullable
last_transaction_atstring date-time nullable
transaction_countinteger
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "7d4f2a8b-9c16-4e3d-a1b5-3f8e9d2c7b4a",
    "company_id": "550e8400-e29b-41d4-a716-446655440000",
    "amount_cents": 9900,
    "amount": {
      "amount": "9900.0",
      "formatted": "$9.900",
      "cents": "9900.0",
      "currency_iso": "CLP"
    },
    "currency": "CLP",
    "frequency": "monthly",
    "confidence_score": "87.5",
    "status": "pending",
    "transaction_count": 6
  }
]