Skip to main content

SubscribedEvent

A new holding subscription was placed.

costdecimalrequired

Principal amount invested in the holding's currency.

Example: 10000.00
currencystringrequired

Three-letter currency code for the holding.

Example: GBP
cursorstringrequired

Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.

Example: ev1.abc123.xyz789
entityCodestringrequired

Code identifying the organisation (client) this event belongs to.

Example: TEST001
eventTypestringrequired
Constant value: SUBSCRIBED
ftfTypestring | nullnullable

Fixed or Extendable, as type on GET /holding. Null on events recorded before this field was added.

Example: Fixed
holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda
maturityDatestringrequired

Date (YYYY-MM-DD) the holding is scheduled to mature.

Example: 2025-01-01
maturityValuedecimalrequired

Expected or actual maturity value (principal plus interest) in the holding's currency.

Example: 10250.00
mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319
mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967
obligorExposureCodestringrequired

Code identifying the obligor exposure (counterparty) for this holding.

Example: BACR
productCodestringrequired

Identifier of the product this holding is in.

Example: GBP-BACR[GC]-3M
subscriptionDatestringrequired

Date (YYYY-MM-DD) the holding starts, when it is due to be funded and issued. For a rolled holding, the previous holding's maturity date. TreasurySpring can change this and maturityDate without a new event (for example when cash arrives late); the ISSUED event carries the issue date and final maturity date, and GET /holding always has the current dates.

Example: 2024-01-01
subscriptionUidstringrequired

Unique identifier of the subscription. For a rolled or switched holding, this matches the subscriptionUid on the previous holding's ROLL or SWITCH maturity action.

Example: dade0389c66241bd8366b017f1ffe19a
uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001
yielddecimalrequired

Current yield for the holding at the time of the event (annualised APY).

Example: 4.000000
SubscribedEvent
{
  "cost": "10000.00",
  "currency": "GBP",
  "cursor": "ev1.abc123.xyz789",
  "entityCode": "TEST001",
  "eventType": "SUBSCRIBED",
  "ftfType": "Fixed",
  "holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
  "maturityDate": "2025-01-01",
  "maturityValue": "10250.00",
  "mmyA360F": "3.88681319",
  "mmyA365F": "3.9407967",
  "obligorExposureCode": "BACR",
  "productCode": "GBP-BACR[GC]-3M",
  "subscriptionDate": "2024-01-01",
  "subscriptionUid": "dade0389c66241bd8366b017f1ffe19a",
  "uid": "00000000000000000000000000000001",
  "yield": "4.000000"
}