Read Only Refund Payment Plan

Retrieve refund payment plan

get

Retrieve a specific refund payment plan by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

A single refund payment plan

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptionalExample: 1

cancellation_planintegerOptional

ID of the associated cancellation plan

Example: 1

transaction_typeobject · enumOptional

Status of the payment type.

Example: cancelledPossible values:

refund_amountnumber · decimalOptional

Total refund amount for the payment plan

Example: 100

retry_countintegerOptional

Number of retry attempts for the payment plan

Example: 0

statusstring · enumOptional

Status of the refund payment plan

Example: pendingPossible values:

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get/api/v1/readonly_refund_payment_plans/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/readonly_refund_payment_plans/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "cancellation_plan": 1,
  "transaction_type": "cancelled",
  "refund_amount": 100,
  "retry_count": 0,
  "status": "pending",
  "created_date": "2026-07-10T19:31:55.828Z",
  "modified_date": "2026-07-10T19:31:55.828Z"
}

List refund payment plans

get

List all refund payment plans

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

cancellation_plan_idintegerOptional

Cancellation Plan ID

transaction_typeobject · enumOptional

Status of the payment type.

Example: cancelledPossible values:

statusstring · enumOptional

Status of the refund payment plan

Example: pendingPossible values:

Responses

200

A list of refund payment plans

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptionalExample: 1

cancellation_planintegerOptional

ID of the associated cancellation plan

Example: 1

transaction_typeobject · enumOptional

Status of the payment type.

Example: cancelledPossible values:

refund_amountnumber · decimalOptional

Total refund amount for the payment plan

Example: 100

retry_countintegerOptional

Number of retry attempts for the payment plan

Example: 0

statusstring · enumOptional

Status of the refund payment plan

Example: pendingPossible values:

401

Unauthorized Access

application/json

500

Server Error

get/api/v1/readonly_refund_payment_plans/

HTTPcURLJavaScriptPython

GET /api/v1/readonly_refund_payment_plans/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2026-07-10T19:31:55.828Z",
    "modified_date": "2026-07-10T19:31:55.828Z"
  }
]