# Spend Limits

These APIs help you manage spend limits that are applied on your profile or card.

Operations 

## The Profile Limits resource 

type
The type of transaction. One of `PURCHASE`, `ATM_WITHDRAWAL`.  `PURCHASE` is a combined limit that applies to Contactless,
Magnetic, Online purchase, Chip and PIN/mobile wallet transactions

value
Daily or monthly limit. The value should be between 0 and the max allowed

usage
The total authorised amount till date

max
The max allowed limit for [daily or monthly](https://wise.com/help/articles/2899986/what-are-my-spending-limits)

resetAt
The time when the limit get reset. ISO-8601 timestamp with timezone (Z)

Profile Limits Resource

```json
{
  "type": "PURCHASE",
  "aggregateWindow": {
    "daily": {
      "value": {
        "amount": 20000.00,
        "currency": "GBP"
      },
      "usage": {
        "amount": 0.00,
        "currency": "GBP"
      },
      "max": {
        "amount": 30000.00,
        "currency": "GBP"
      },
      "resetAt": "2023-07-31T22:59:59.999999999Z"
    },
    "monthly": {
      "value": {
        "amount": 20000.00,
        "currency": "GBP"
      },
      "usage": {
        "amount": 0.00,
        "currency": "GBP"
      },
      "max": {
        "amount": 30000.00,
        "currency": "GBP"
      },
      "resetAt": "2023-07-31T22:59:59.999999999Z"
    }
  }
}
```

## The Card Limits resource 

value
Optional transaction, daily, monthly or lifetime limit

usage
The total authorised amount during the specified window. The value is always 0 for transaction limit

resetAt
The time when the limit gets reset. ISO-8601 timestamp with timezone (Z). A null value is returned for transaction and lifetime limit

Card Limits Resource

```json
{
  "transaction": {
    "value": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 0.00,
      "currency": "GBP"
    },
    "resetAt": null
  },
  "daily": {
    "value": {
      "amount": 2000.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "resetAt": "2023-09-29T22:59:59.999999999Z"
  },
  "monthly": null,
  "lifetime": {
    "value": {
      "amount": 5000.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "resetAt": null
  }
}
```

## Retrieve profile limits 

**`GET /v4/spend/profiles/{{profileId}}/spend-limits `**

Retrieves the spend limits that are configured for a `profileId`.

#### Response

Returns a list of [profile limits object](/api-reference/spend-limits#profile-limits)

Example Request

```shell
curl -X GET \
  'https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/spend-limits' \
  -H 'Authorization: Bearer <your api token>'
```

Example Response

```json
{
  "spendLimits": [
    {
      "type": "PURCHASE",
      "aggregateWindow": {
        "daily": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 30000.00,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        },
        "monthly": {
          "value": {
            "amount": 20000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 30000.00,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        }
      }
    },
    {
      "type": "ATM_WITHDRAWAL",
      "aggregateWindow": {
        "daily": {
          "value": {
            "amount": 1000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 4000.00,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        },
        "monthly": {
          "value": {
            "amount": 1000.00,
            "currency": "GBP"
          },
          "usage": {
            "amount": 0.00,
            "currency": "GBP"
          },
          "max": {
            "amount": 4000.00,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z"
        }
      }
    }
  ]
}
```

## Update profile limits 

**`PATCH /v4/spend/profiles/{{profileId}}/spend-limits `**

Update profile daily and monthly spend limits for `PURCHASE` or `ATM_WITHDRAWAL`.

Request
type
The type of transaction. One of `PURCHASE`, `ATM_WITHDRAWAL`

value
The amount allowed to be spent for the chosen `type`, both daily and monthly must be set

#### Response

See [Retrieve profile limits](/api-reference/spend-limits#get-profile-limits)

Example Request

```shell
curl -X PATCH \
  https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/spend-limits \
  -H 'Authorization: Bearer <your api token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "PURCHASE",
    "aggregateWindow": {
      "daily": {
        "value": {
          "amount": 20000.00,
          "currency": "GBP"
        }
      },
      "monthly": {
        "value": {
          "amount": 20000.00,
          "currency": "GBP"
        }
      }
    }
  }'
```

## Retrieve card limits 

**`GET /v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits `**

Retrieves the spend limits that are configured for a `card`.

#### Response

Returns a list of [card limits object](/api-reference/spend-limits#card-limits)

Example Request

```shell
curl -X GET \
  'https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits' \
  -H 'Authorization: Bearer <your api token>'
```

Example Response

```json
{
  "transaction": {
    "value": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 0.00,
      "currency": "GBP"
    },
    "resetAt": null
  },
  "daily": {
    "value": {
      "amount": 2000.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "resetAt": "2023-09-29T22:59:59.999999999Z"
  },
  "monthly": {
    "value": {
      "amount": 3000.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "resetAt": "2023-09-30T22:59:59.999999999Z"
  },
  "lifetime": {
    "value": {
      "amount": 5000.00,
      "currency": "GBP"
    },
    "usage": {
      "amount": 100.00,
      "currency": "GBP"
    },
    "resetAt": null
  }
}
```

## Create or update card limits 

**`PATCH /v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits `**

Create or update card transaction, daily, monthly or lifetime spend limits.

Request
value
The amount allowed to be spent on the card during the specified period

#### Response

See [Retrieve card limits](/api-reference/spend-limits#get-card-limits)

Example Request

```shell
curl -X PATCH \
  https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits \
  -H 'Authorization: Bearer <your api token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "daily": {
      "value": {
        "amount": 1000.00,
        "currency": "GBP"
      }
    },
    "monthly": {
      "value": {
        "amount": 1000.00,
        "currency": "GBP"
      }
    }
  }'
```

## Delete card limits 

**`DELETE /v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits/{{granularity}} `**

Delete card spend limits. The granularity must be set to transaction, daily, monthly or lifetime.

#### Response

See [Retrieve card limits](/api-reference/spend-limits#get-card-limits)

Example Request

```shell
curl -X DELETE \
  https://api.sandbox.transferwise.tech/v4/spend/profiles/{{profileId}}/cards/{{cardToken}}/spend-limits/daily \
  -H 'Authorization: Bearer <your api token>'
```