Private API Reference

Limits

You can set limits at the Account, Account Number, or Card level. Limits applied to Accounts will apply to all Account Numbers and Cards in the Account. You can specify any number of Limits and they will all be applied to inbound debits and card authorizations. Volume and count Limits are designed to prevent unauthorized debits.

The Limit object

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "limit_fku42k0qtc8ulsuas38q",
  "idempotency_key": null,
  "interval": "month",
  "metric": "volume",
  "model_id": "account_number_v18nkfqm6afpsrvy82b2",
  "model_type": "account_number",
  "status": "active",
  "type": "limit",
  "value": 0
}

Attributes

created_at

string

The ISO 8601 date and time at which the limit was created.

string

The Limit 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.

interval

enum

Nullable

The interval for the metric. This is required if metric is count or volume.

metric

enum

The metric for the Limit.

model_id

string

The identifier of the Account Number, Account, or Card the Limit applies to.

model_type

enum

The type of the model you wish to associate the Limit with.

status

enum

The current status of the Limit.

type

string

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

value

integer

The value to evaluate the Limit against.

List Limits

curl \
  --url "${INCREASE_URL}/limits?model_id=account_number_v18nkfqm6afpsrvy82b2&status=active" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Limit object */ },
    { /* Limit object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

model_id

string

The model to retrieve limits for.

Between 1 and 200 characters

status

string

The status to retrieve limits for.

Between 1 and 200 characters

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

cursor

string

limit

integer

Create a Limit

curl -X "POST" \
  --url "${INCREASE_URL}/limits" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "interval": "month",
    "metric": "volume",
    "model_id": "account_in71c4amph0vgo2qllky",
    "value": 1234
  }'

Parameters

interval

enum

The interval for the metric. Required if metric is count or volume.

metric

enum

Required

The metric for the limit.

model_id

string

Required

The identifier of the Account or Account Number you wish to associate the limit with.

Between 1 and 200 characters

value

integer

Required

The value to test the limit against.

Retrieve a Limit

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

Parameters

limit_id

string

Required

The identifier of the Limit to retrieve.

Update a Limit

curl -X "PATCH" \
  --url "${INCREASE_URL}/limits/limit_fku42k0qtc8ulsuas38q" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "inactive"
  }'

Parameters

limit_id

string

Required

The limit to update.

status

enum

Required

The status to update the limit with.