v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Recurring charge plans

List recurring charge plans

Returns a list of recurring charge plans.

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/recurring-charge-plans

Query parameters

pageinteger

Example:3

Page number

perPageinteger

Example:10

Maximum number of items per page

activeboolean

Example:true

If true, the request returns only active plans.

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 results. If no records are found, the request returns an empty array with total_items set to 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_charge_plan_id": 115563,
      "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
      "processing_code": "99066",
      "installment_amount": 10.9,
      "secondary_processing_code": "99067",
      "number_of_cycles": 12,
      "first_cycles_to_discount": 3,
      "discount_percentage": 50,
      "minimum_spend_to_charge": 100,
      "renew_method": "WITH_DISCOUNT",
      "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
      "cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "created_at": "2024-09-12T16:46:16.43663522"
    }
  ]
}