Plan ID

What is Plan ID

When creating a proposal, you need to specify the rules for installments or taxes, all of which are defined in the plans you have established offline with Liquido. The Plan ID is used to specify which plan the proposal needs to use, and you can retrieve specific plan details through Retrieve A Plan.

The following are examples of an Installment Plan and a Tax Plan:

Installment Plan

{
    "id": "PLAN-ID-INSTALLMENT",
    "type": "INSTALLMENT",
    "planDetails": {
        "installment": [
            {
                "modifierType": "RATE",
                "rate": 0.02,
                "installments": 3
            },
            {
                "modifierType": "RATE",
                "rate": 0.05,
                "installments": 6
            },
            {
                "modifierType": "RATE",
                "rate": 0.1,
                "installments": 12
            }
        ]
    }
}

Tax Plan

{
    "id": "PLAN-ID-TAX",
    "type": "Tax",
    "planDetails": {
        "tax": [
            {
                "modifierType": "RATE",
                "rate": 0.0038,
                "type": "BR_IOF_FX_TAX"
            }
        ]
    }
}

When creating a proposal, you will use the Plan ID to implement specific rules. Below is an example (for details, please refer to Create A Proposal with Multiple Intentions):

Create Proposal

{
    "amount": 100000,
    "country": "BR",
    "currency": "BRL",
    "installmentPlanId": "PLAN-ID-INSTALLMENT",
    "taxPlanId": "PLAN-ID-TAX"
}

How to get Plan ID

Currently Plan IDs are only provided offline, please reach out to Liquido to get Plan IDs.

Supported Type of Plan ID

Type	Field Name of Plan ID Used to Create Proposals
Installments	installmentPlanId
Tax	taxPlanId