Tax Wrappers

Tax Wrappers

Download Spec

All tax wrappers related paths

post/isa/wrappers

Create a tax wrapper for ISA account

Creates a tax wrapper for ISA account.

account_group_idstring

required

The ID of the account group to which the tax wrapper belongs.

Format: uuid

typestring

required

Types of the ISA tax wrapper

Default: "STOCKS_AND_SHARES_ISA"
Enum: STOCKS_AND_SHARES_ISA

is_flexibleboolean

required

True if ISA is flexible.

Responses

Request examples

{
  "account_group_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa",
  "type": "STOCKS_AND_SHARES_ISA",
  "is_flexible": true
}

Response examples

ISA tax wrapper created.

{
  "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
  "created_at": "2025-10-05T14:48:00.000Z",
  "updated_at": "2025-10-05T14:48:00.000Z",
  "account_group_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa",
  "is_flexible": true,
  "status": "NEW",
  "type": "STOCKS_AND_SHARES_ISA"
}

get/isa/wrappers/{tax_wrapper_id}/allowances

Retrieve ISA allowances

Retrieves ISA allowances

tax_yearstring

Filter allowances by tax_year YYYY/YYYY

Pattern: ^[0-9]{4}\/[0-9]{4}$

sortstring

Sort the result by created_at or valid_from

Default: "created_at"
Enum: created_at
valid_from

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "valid_from",
    "order": "DESC"
  },
  "data": [
    {
      "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
      "created_at": "2025-10-05T14:48:00.000Z",
      "updated_at": "2025-10-05T14:48:00.000Z",
      "tax_wrapper_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa",
      "tax_year": "2025/2026",
      "type": "ANNUAL",
      "status": "ACTIVE",
      "currency": "GBP",
      "used_amount": "0.00",
      "remaining_amount": "20000.00",
      "valid_from": "2025-04-06T00:00:00.000Z",
      "valid_to": "2026-04-05T23:59:59.000Z",
      "first_subscription_at": "2025-04-06T00:00:00.000Z"
    }
  ]
}

webhook

ISA Tax Wrappers events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

The type of ISA tax wrapper event

NEW - The tax wrapper is newly created and not yet active due to pending checks.
ACTIVE - The tax wrapper is currently active and in use.
INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed.
CLOSED - The tax wrapper has been closed and is no longer available.

Enum: ISA_WRAPPER.NEW
ISA_WRAPPER.ACTIVE
ISA_WRAPPER.INACTIVE
ISA_WRAPPER.CLOSED

objectobject (Tax Wrappers - ISA Tax Wrapper)

required

idstring

required

Tax wrapper unique identifier.

Format: uuid

created_atstring

required

The date and time the tax wrapper was created.

Format: date-time

updated_atstring

required

The date and time the tax wrapper was last updated.

Format: date-time

account_group_idstring

required

Account group unique identifier.

Format: uuid

is_flexibleboolean

required

True if tax wrapper is flexible.

statusstring

required

Status of the tax wrapper

NEW - The tax wrapper is newly created and not yet active due to pending checks.
ACTIVE - The tax wrapper is currently active and in use.
INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed.
CLOSED - The tax wrapper has been closed and is no longer available.

Enum: NEW
ACTIVE
INACTIVE
CLOSED

typestring

required

Types of the ISA tax wrapper

Default: "STOCKS_AND_SHARES_ISA"
Enum: STOCKS_AND_SHARES_ISA

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "295cf14f-368c-450e-b57e-48d115d30fe4",
  "created_at": "2025-08-01T10:34:43Z",
  "type": "ISA_WRAPPER.NEW",
  "object": {
    "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
    "created_at": "2025-08-01T10:33:43Z",
    "updated_at": "2025-08-01T10:33:43Z",
    "account_group_id": "d4b5c6e7-89f0-4a1b-9c2d-3e4f5a6b7c8d",
    "is_flexible": true,
    "status": "NEW",
    "type": "STOCKS_AND_SHARES_ISA"
  },
  "webhook_id": "4a80c45f-204c-4498-ac20-d900a846e166"
}

Response examples

Request has been processed successfully.

Empty response

webhook

ISA Allowance events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

The type of ISA allowance event:

CREATED: Allowance was created.
UPDATED: Allowance was updated.
EXPIRED: Allowance is no longer valid.

Enum: ISA_WRAPPER_ALLOWANCE.CREATED
ISA_WRAPPER_ALLOWANCE.UPDATED
ISA_WRAPPER_ALLOWANCE.EXPIRED

objectobject (Tax Wrappers - ISA Allowance)

required

idstring

required

Allowance unique identifier.

Format: uuid

created_atstring

required

The date and time the tax wrapper was created.

Format: date-time

updated_atstring

required

The date and time the tax wrapper was last updated.

Format: date-time

tax_wrapper_idstring

required

Tax wrapper unique identifier.

Format: uuid

tax_yearOne Of

Must match one of

typestring

required

Type of the allowance:

ANNUAL - Allowance valid for a tax year.

Default: "ANNUAL"
Enum: ANNUAL

statusstring

required

Status of the allowance:

ACTIVE - Current allowance.
EXPIRED - Allowance from previous years.

Enum: ACTIVE
EXPIRED

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

GBP - British Pound Sterling

Default: "GBP"
Enum: GBP

used_amountstring

required

Pattern: ^-?[0-9]{1,9}(\.[0-9]{2})?$

remaining_amountstring

required

Pattern: ^-?[0-9]{1,9}(\.[0-9]{2})?$

valid_fromstring

required

The date from which the allowance is valid.

Format: date-time

valid_toOne Of

Must match one of

first_subscription_atOne Of

Must match one of

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "295cf14f-368c-450e-b57e-48d115d30fe4",
  "created_at": "2025-08-01T10:34:43Z",
  "type": "ISA_WRAPPER_ALLOWANCE.UPDATED",
  "object": {
    "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
    "created_at": "2025-10-05T14:48:00.000Z",
    "updated_at": "2025-10-05T14:48:00.000Z",
    "tax_wrapper_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa",
    "tax_year": "2025/2026",
    "type": "ANNUAL",
    "status": "ACTIVE",
    "currency": "GBP",
    "used_amount": "1000.00",
    "remaining_amount": "19000.00",
    "valid_from": "2025-04-06T00:00:00.000Z",
    "valid_to": "2026-04-05T23:59:59.000Z",
    "first_subscription_at": "2025-05-13T00:00:00.000Z"
  },
  "webhook_id": "4a80c45f-204c-4498-ac20-d900a846e166"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?