Skip to main content
GET
/
installments-plans
/
{installment_code}
Get Installments Plan by ID
curl --request GET \
  --url https://api-sandbox.y.uno/v1/installments-plans/{installment_code} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'
[
  {
    "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7",
    "name": "plan_007",
    "account_id": [
      "f7c5fe77-721b-49c2-84d3-957748df3c2c"
    ],
    "merchant_reference": "Test",
    "installments_plan": [
      {
        "installment": 1,
        "rate": 1,
        "provider_id": "",
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      },
      {
        "installment": 3,
        "rate": 1,
        "provider_id": "",
        "financial_costs": [
          {
            "type": "CFT",
            "rate": 45.25,
            "formatted_value": "45,25%"
          },
          {
            "type": "TEA",
            "rate": 38.5,
            "formatted_value": "38,50%"
          }
        ],
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      },
      {
        "installment": 6,
        "rate": 1,
        "provider_id": "",
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      },
      {
        "installment": 9,
        "rate": 1,
        "provider_id": "",
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      },
      {
        "installment": 12,
        "rate": 1,
        "provider_id": "",
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      }
    ],
    "iin": null,
    "country_code": "US",
    "first_installment_deferral": 0,
    "amount": {
      "Currency": "USD",
      "min_value": 0,
      "max_value": 100000000
    },
    "availability": {
      "start_at": "2023-09-12T00:00:00Z",
      "finish_at": "2030-09-20T00:00:00Z"
    },
    "created_at": "2023-10-11T17:52:31.886178Z",
    "updated_at": "2023-10-11T17:52:31.886178Z",
    "payment_method_type": "NU_PAY_ENROLLMENT"
  }
]
The Get Installments Plan API lets you retrieve detailed information about an existing installment plan. This includes the plan’s installment options, billing frequency, amount limits, and other relevant details. Use this endpoint to fetch the current configuration of a specific installment plan.

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

​
installment_code
string
required

Identifier of the installment plan.

Response

200

​
id
string
Example:

"4d573425-33f9-4c46-b009-2c7e749b0ec7"

​
name
string
Example:

"plan_007"

​
account_id
string[]
​
merchant_reference
string
Example:

"Test"

​
installments_plan
object[]
​
iin
any
​
country_code
string
Example:

"US"

​
first_installment_deferral
integer
default:0
Example:

0

​
amount
object
​
availability
object
​
created_at
string
Example:

"2023-10-11T17:52:31.886178Z"

​
updated_at
string
Example:

"2023-10-11T17:52:31.886178Z"

​
payment_method_type
string
Example:

"NU_PAY_ENROLLMENT"