Private API Reference

Interest Rate Plans

Interest Rate Plans are used to calculate the interest rate for accounts.

Events

Your application can listen to webhooks about this resource. The events about Interest Rate Plans will have the categories "interest_rate_plan.created" or "interest_rate_plan.updated" .

The Interest Rate Plan object

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "interest_rate_plan_tgj91bw7fhrhlw23hpo8",
  "idempotency_key": null,
  "interest_rate": "0.055",
  "interest_rate_calculation": {
    "base_plus_offset": null,
    "calculation_method": "fixed_rate",
    "fixed_rate": {
      "value": "0.055"
    },
    "percentage_of_base": null
  },
  "name": "Interest Rate Plan 1",
  "path": "/interest_rate_plans/interest_rate_plan_tgj91bw7fhrhlw23hpo8",
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "type": "interest_rate_plan"
}

Attributes

created_at

string

The ISO 8601 time at which the Interest Rate Plan was created.

string

The Interest Rate Plan identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

interest_rate

string

The interest rate currently being earned according to the Interest Rate Plan, as a string containing a decimal number. For example, a 1% interest rate would be represented as “0.01”.

interest_rate_calculation

dictionary

How the interest rate is calculated for this Interest Rate Plan.

name

string

The name you choose for the Interest Rate Plan.

program_id

string

The identifier of the Program determining the compliance and commercial terms of this Interest Rate Plan.

More about Programs.

type

string

A constant representing the object’s type. For this resource it will always be interest_rate_plan.

List Interest Rate Plans

curl \
  --url "${INCREASE_URL}/interest_rate_plans" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Interest Rate Plan object */ },
    { /* Interest Rate Plan object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

program_id

string

Filter Interest Rate Plans to those belonging to the specified Program.

More about Programs.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

Create an Interest Rate Plan

curl -X "POST" \
  --url "${INCREASE_URL}/interest_rate_plans" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "interest_rate_calculation": {
      "calculation_method": "fixed_rate",
      "fixed_rate": {
        "value": "0.01"
      }
    },
    "name": "Tier 1",
    "program_id": "program_i2v2os4mwza1oetokh9i"
  }'

Parameters

interest_rate_calculation

dictionary

Required

How the interest rate is calculated for this Interest Rate Plan.

name

string

Required

The name you choose for the Interest Rate Plan.

Between 1 and 200 characters

program_id

string

Required

The identifier of the Program the Interest Rate Plan falls under.

More about Programs.

Retrieve an Interest Rate Plan

curl \
  --url "${INCREASE_URL}/interest_rate_plans/interest_rate_plan_tgj91bw7fhrhlw23hpo8" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

interest_rate_plan_id

string

Required

The identifier of the Interest Rate Plan.

Update an Interest Rate Plan

curl -X "PATCH" \
  --url "${INCREASE_URL}/interest_rate_plans/interest_rate_plan_tgj91bw7fhrhlw23hpo8" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "name": "Tier 1"
  }'

Parameters

interest_rate_plan_id

string

Required

The identifier of the Interest Rate Plan to update.

interest_rate_calculation

dictionary

How the interest rate is calculated for this Interest Rate Plan.

name

string

The name you choose for the Interest Rate Plan.

Between 1 and 200 characters