Recurring charge links

List recurring charge plan links

Gets all the links for a plan, given the plan ID.

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/{recurring_charge_plan_id}/accounts

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/recurring-charge-plans/{recurring_charge_plan_id}/accounts
  • Auth
    none declared

Path parameters

recurring_charge_plan_idinteger required
Example:98660282

ID of the recurring charge plan

Query parameters

pageinteger
Example:3

Page number

perPageinteger
Example:10

Maximum number of items per page

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 links. If no links 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_charge_link_id": 98660282,
      "account_id": 6912345,
      "recurring_charge_plan_id": 115563,
      "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
      "created_at": "2024-09-12T16:46:16.43663522",
      "cancelled_at": "2023-03-30T12:26:41",
      "end_date": "2023-03-30T12:26:41",
      "description": "Link between an account and a recurring charge plan",
      "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
      "creation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
      "cancellation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.