v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Recurring scheduled charges

List scheduled charges

Gets all the scheduled charges for a given account, filtered by the query parameters.

NOTE: This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

get/v1/accounts/{account_id}/scheduled-charges

Path parameters

account_idinteger required

Example:6912345

Account ID

Query parameters

pageinteger

Example:3

Page number

perPageinteger

Example:10

Maximum number of items per page

recurringChargeLinkIdinteger

Example:100123

Link ID. Only scheduled charges generated by the given link are returned.

statementIdinteger

Example:200123

Statement ID. Only scheduled charges that appear on the given statement are returned.

status'PENDING' | 'PROCESSING' | 'PROCESSED' | 'SETTLED' | 'CANCELLED'

Example:PROCESSED

Charge status. The possible values are PENDING,PROCESSING, PROCESSED, SETTLED, and CANCELLED.

authorizationIdinteger

Example:300123

Authorization ID. Only scheduled charges with this authorization ID are returned.

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Response

OK - Indicates that the server accepted the request and returned the list of charges. If no charges are found, an empty array is returned and total_items is 0.

current_pageinteger

Current page number

per_pageinteger

Maximum number of items per page

pagesinteger

Number of pages

total_itemsinteger

Total number of items

is_last_pageboolean

Set to true if this is the last page.

Example response

{
  "current_page": 1,
  "per_page": 15,
  "pages": 10,
  "total_items": 100,
  "items": [
    {
      "recurring_scheduled_charge_id": 880077,
      "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
      "account_id": 6912345,
      "created_at": "2024-09-12T16:46:16.43663522",
      "updated_at": "2024-09-12T16:46:16.43663522",
      "statement_id": 9497889,
      "recurring_charge_link_id": 98660282,
      "status": "PENDING",
      "creation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "cancellation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "processing_code": "99066",
      "installment_amount": 10.9,
      "description": "Link between an account and a recurring charge plan",
      "authorization_id": 1099901,
      "authorization_tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "secondary_processing_code": "99067",
      "secondary_installment_amount": 5.45,
      "secondary_description": "Link between an account and a recurring charge plan",
      "secondary_authorization_id": 1099901,
      "secondary_authorization_tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "cycle": 4
    }
  ]
}