Skip to content

Get list of payment plans

Request

Get list of payment plans

Security
bearer and basic and apiKey
Query
Pageinteger, (int32)

Specifies page number

Example:Page=2
CreatedAtFromany, (date-time)

The createdAt date time lower limit

Example:CreatedAtFrom=2025-05-12
CreatedAtToany, (date-time)

The createdAt date time upper limit

Example:CreatedAtTo=2025-05-15
LastBillingFromany, (date-time)

The last billing date time lower limit

Example:LastBillingFrom=2025-05-12
LastBillingToany, (date-time)

The last billing date time upper limit

Example:LastBillingTo=2025-05-15
PaymentPlanIdstring

The Id of payment plan

Example:PaymentPlanId=c12e7a1524d2462fabf0839a7cf7dd09
MerchantCustomerIdstring

The merchant customer id

Example:MerchantCustomerId=Test_Merchant
Currencystring

Currency

Example:Currency=EUR
AmountFrominteger, (int32)

Lower limit of the amount

Example:AmountFrom=100
AmountTointeger, (int32)

Upper limit of the amount

Example:AmountTo=100
Amountinteger, (int32)

Exact amount value

Example:Amount=100
PlanStatusstring

Payment plan status

Enum:"ACTIVE""CANCELLED""INVALID""COMPLETED""RETRY"
Example:PlanStatus=ACTIVE
PlanTypestring

Payment plan status

Enum:"RECURRING""INSTALLMENTS""DELAYED_SHIPMENT""UNSCHEDULED_MIT"
Example:PlanType=RECURRING
curl -i -X GET \
  -u '<username>:<password>' \
  'https://test.paygate.nexigroup.com/api/v2/payment-plans?Page=2&CreatedAtFrom=2025-05-12&CreatedAtTo=2025-05-15&LastBillingFrom=2025-05-12&LastBillingTo=2025-05-15&PaymentPlanId=c12e7a1524d2462fabf0839a7cf7dd09&MerchantCustomerId=Test_Merchant&Currency=EUR&AmountFrom=100&AmountTo=100&Amount=100&PlanStatus=ACTIVE&PlanType=RECURRING' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Payment plans successfully retrieved

Bodyapplication/json
totalNumberOfPagesinteger, (int32)

Indicates total number of pages that exist.

totalNumberOfItemsinteger, (int32)

Indicates total number of items that exist.

pageinteger, (int32)

Indicates number of page that is retrieved.

pageSizeinteger, (int32)

Indicates max number of items on page.

dataArray of objects(paymentPlanItem)
Response
{ "totalNumberOfPages": 5, "totalNumberOfItems": 82, "page": 5, "pageSize": 20, "data": [ { … }, { … } ] }