Skip to main content
PATCH
/
installments-plans
/
{installment_code}
Update Plan
curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/installments-plans/{installment_code} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "name": "Plan Update",
  "account_id": [
    "{{account_id}}"
  ],
  "merchant_reference": "REF01",
  "installments_plan": [
    {
      "installment": 3,
      "rate": 1.05,
      "financial_costs": [
        {
          "type": "CFT",
          "rate": 15.5
        }
      ],
      "type": "MERCHANT_INSTALLMENTS"
    },
    {
      "installment": 6,
      "rate": 1.1
    },
    {
      "installment": 12,
      "rate": 1.2
    }
  ],
  "country_code": "US",
  "scheme": "VISA",
  "brand": [
    "VISA",
    "MASTERCARD"
  ],
  "issuer": "JPMORGAN CHASE BANK",
  "iin": [
    "411111",
    "542418"
  ],
  "first_installment_deferral": 1,
  "amount": {
    "currency": "USD",
    "min_value": 50,
    "max_value": 10000
  },
  "availability": {
    "start_at": "2024-01-01T00:00:00.000Z",
    "finish_at": "2024-12-31T23:59:59.999Z"
  }
}
'
{
  "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": ""
    },
    {
      "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%"
        }
      ]
    },
    {
      "installment": 6,
      "rate": 1,
      "provider_id": ""
    },
    {
      "installment": 9,
      "rate": 1,
      "provider_id": ""
    },
    {
      "installment": 12,
      "rate": 1,
      "provider_id": ""
    }
  ],
  "type": "",
  "source": "",
  "provider_id": "",
  "scheme": "",
  "brand": [
    "VISA"
  ],
  "issuer": "",
  "issuer_id": "",
  "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.886178246Z",
  "updated_at": "2023-10-11T17:52:31.886178246Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.y.uno/llms.txt

Use this file to discover all available pages before exploring further.

The Update Plan API allows you to modify an existing plan, enabling you to update attributes such as the plan’s status, installment details, and the payment method associated with the plan. Use this API to manage and adjust subscription plans after creation.

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

The unique identifier of the installment plan.

Body

application/json
​
name
string

The installment plan name (MAX 255; MIN 3)

​
account_id
string[]

The unique identifier of Yuno's account that will have the installment plan available to use (MAX 64 ; MIN 36).

​
merchant_reference
string

Identification of the installment plan (MAX 255; MIN 3)

​
installments_plan
object[]

Definition of installments available for each scenario

​
country_code
string

The issuer's country (ISO 3166-1 MAX 2; MIN 2)

​
scheme
string

Card’s scheme information. (MAX 255; MIN 3)

​
brand
string[]

Card’s brand information (MAX 255; MIN 3).

​
issuer
string

Card issuer (MAX 255; MIN 3)

​
iin
string[]

The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6)

​
first_installment_deferral
integer<int32>

The amount of months to wait to debit the first installment Mas:3

​
amount
object

The amounts that the installment plan will be available for. If null, available for any amount.

​
availability
object

The dates that the installment plan will be available for. If null then it does not have a finish date

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[]
​
type
string
Example:

""

​
source
string
Example:

""

​
provider_id
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.886178246Z"

​
updated_at
string
Example:

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