Sign in

v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB
Recurring charge

List recurring charges

Returns a paginated list of the company's recurring charges (subscription-like expected charges), each including its merchant and vendor_card summaries and computed fields (finalized?, days_since_expected, overdue?, amount). Sorting by the virtual field next_expected_at is supported. Non-admin callers see charges they own, charges on their cards, or all company charges if they hold card_transactions_manage.

get/v1/recurring_charges

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

activeboolean

Filter by active state.

merchant_idstring uuid

Filter by merchant.

vendor_card_idstring

Filter by card.

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 recurring charges

idstring uuid required
company_idstring uuid required
user_idstring nullable

The owning user (defaults to the current user on creation).

merchant_idstring uuid nullable
vendor_card_idstring nullable

The card expected to be charged.

amount_centsinteger required

Expected charge amount in cents.

currencystring required
frequency'weekly' | 'biweekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual' required
source'manual' | 'auto_detected'
start_datestring date required
end_datestring date nullable
next_expected_atstring date nullable

Next date a charge is expected.

activeboolean
descriptionstring nullable
confidence_scorestring nullable

Detection confidence (0-100), for auto-detected charges.

last_matched_atstring date-time nullable
supporting_transaction_idsstring[]

Ids of the card transactions that support / were matched to this recurring charge (jsonb array; defaults to an empty array).

finalizedboolean

Whether the charge has ended. Serialized in JSON as finalized?.

overdueboolean

Whether the next expected charge is overdue. Serialized in JSON as overdue?.

days_since_expectedinteger nullable

Days elapsed since the charge was last expected.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "3e5f7a9c-1d2b-4c6e-8a9f-2b4c5d6e7f8a",
    "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",
    "source": "manual",
    "start_date": "2025-01-01",
    "active": true
  }
]