v1

latestOpenAPI 3.1.02026-08-043160244.3 KB

Subscriptions

Get a single subscription by id

Retrieves a single subscription if the user has permission to view it. Useful for tracking a subscription returned by /subscribe until its holdingUid is populated. Once holdingUid exists, treat the holding as the live source of truth.

get/subscription/{entity_code}/{uid}

Path parameters

entity_codestring required

Entity code

uidstring required

Subscription uid

Response

Subscription information

amountnumber required

Subscription amount

cellCodestring required

Cell code

currencystring required

Subscription currency

cutoffDatetimestring date-time required

Cut-off datetime for this subscription (timezone aware). Last point at which the subscription's maturity action can be changed before TreasurySpring locks it in.

entityCodestring required

Subscribing Entity Code

holdingUidstring nullable

Holding uid

indicationUidstring nullable

Indication uid

maturityActionstring required

Maturity action

maturityDatestring date required

Date the holding will mature

obligorExposureCodestring required

Obligor exposure code

obligorExposureNamestring required

Obligor exposure name

productCodestring required

Product code

releaserEmailstring nullable

Releaser email

signerEmailstring nullable

Signer email

sourcestring required

Source of funds

status'PENDING' | 'ACCEPTED' | 'DECLINED' | 'CANCELLED' | 'EXPIRED' required

subscriptionDatestring date required

The date to subscribe to the indication

uidstring required

Subscription uid

yieldnumber nullable

Yield agreed at subscribe time (annualised APY).

Example response

{
  "amount": 1000,
  "cellCode": "Example-IC",
  "currency": "GBP",
  "cutoffDatetime": "2024-01-01T12:15:00",
  "entityCode": "TEST0001",
  "holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
  "indicationUid": "ef8b318a15b04784ba86c8667727d78b",
  "maturityAction": "Roll",
  "maturityDate": "2025-01-01",
  "obligorExposureCode": "BACR[GC]",
  "obligorExposureName": "Barclays Bank Plc [Gov secured]",
  "productCode": "GBP-BACR[GC]-3M",
  "releaserEmail": "example@treasuryspring.com",
  "signerEmail": "example@treasuryspring.com",
  "source": "As per Master Subscription Agreement",
  "subscriptionDate": "2024-01-01",
  "uid": "8a1f37f521f146dbaa4a333d0bc26158",
  "yield": 5
}