Skip to content

Get payment plan by id

Request

Get payment plan by id

Security
bearer and basic and apiKey
Path
paymentPlanIdstringrequired
curl -i -X GET \
  -u '<username>:<password>' \
  'https://test.paygate.nexigroup.com/api/v2/payment-plans/{paymentPlanId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Payment plan successfully retrieved

Bodyapplication/json
idstring

Payment plan id.

planStatusstring

Status of the payment plan.

Enum:"ACTIVE""CANCELLED""INVALID""COMPLETED""RETRY"
Example:"ACTIVE"
paymentPlanTypestring

Payment plan type

Enum:"RECURRING""INSTALLMENTS""DELAYED_SHIPMENT""UNSCHEDULED_MIT"
Example:"RECURRING"
triggerTypestring

Returns whether the payment plan is manual or automatic.

merchantCustomerIdstring

Unique identifier of the customer assigned by merchant.

descriptionstring

Description

creationDateany, (date-time)

Date when the payment plan record is created in Paygate.

cancellationDateany, (date-time)

Date when the payment plan was cancelled. Applicable only for recurring and installment payment plans.

lastBillingDateany, (date-time)

Last billing date of the payment plan in ISO 8601 format.

orderobject(orderMini)
paymentMethodobject(paymentMethod)
recurringobject(paymentPlanRecurring)
installmentsobject(paymentPlanInstallments)
delayedShipmentobject(paymentPlanDelayedShipment)
unscheduledMitobject(paymentPlanUnscheduledMit)
Response
{ "Default": { "id": "1082fdd2f2304d479557683731cb8f41", "planStatus": "ACTIVE", "paymentPlanType": "UNSCHEDULED_MIT", "lastBillingDate": "2026-02-18T11:56:52.123+01:00", "amount": { … }, "merchantCustomerId": "FLE_6767_001", "description": "test:payment", "triggerType": "MANUAL", "purchaseAmountInstallment": "0", "nbrInstallments": "0", "frequency": "0", "ceationDate": "2026-02-18T11:56:52.123", "expirationDate": "9999-12-31T23:59:59.997", "cancellationDate": "2026-02-18T11:56:52.123", "paymentMethod": { … } } }