Skip to main content
GET
Get Installments Plan by ID
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

Today the response returns amount.Currency with a capital C, not amount.currency. Read the key case-insensitively.

id
string
Example:

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

name
string
Example:

"plan_007"

account_id
string[]
merchant_reference
string
Example:

"Test"

installments_plan
object[]
source
string
Example:

""

scheme
string
Example:

""

brand
string[]
issuer
string
Example:

""

issuer_id
string
Example:

""

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
enum<string>
Available options:
CARD,
NU_PAY_ENROLLMENT,
APPLE_PAY
Example:

"NU_PAY_ENROLLMENT"

provider_id
string

Provider id.

Example:

""