API Docs / Schemas / SubscriptionDto

SubscriptionDto

Response DTO for subscription information (excludes internal IDs)

Properties

Name Type Description
codestring

The unique code for this subscription

The unique code for this subscription

packageCodeAndNameDto
pricingTierPricingTierDto
monthlyPricePenceinteger

The monthly price in pence

The monthly price in pence

startDatestring

When the subscription started

When the subscription started

endDatestring

When the subscription ends (null for perpetual subscriptions)

When the subscription ends (null for perpetual subscriptions)

commentstring

Optional comment about the subscription

Optional comment about the subscription

isFreeTrialboolean

Whether this subscription is a free trial

Whether this subscription is a free trial

pendingSubscriptionSubscriptionDto

JSON Example

{
  "code": "string",
  "package": {
    "code": "string",
    "name": "string"
  },
  "pricingTier": {
    "code": "string",
    "name": "string",
    "minClients": 0,
    "maxClients": 0,
    "monthlyPricePence": 0
  },
  "monthlyPricePence": 0,
  "startDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas