2.1.1 SubscriptionTermination object

Defines when subscriptions automatically end.

A one-off termination that ends on the 10th of June, 2023 at 20:00h Amsterdam time:

{
  "type": "ONE-OFF",
  "year": 2023,
  "month": 6,
  "day": 10,
  "time": "20:00",
  "timeZone": "Europe/Amsterdam"
}

A recurring annual termination that ends on the 10th of June at 19:42h New York time each year:

{
  "type": "ANNUAL",
  "month": 6,
  "day": 10,
  "time": "19:42",
  "timeZone": "America/New_York"
}

A recurring monthly termination that ends on the 10th of each month at 20:00h Amsterdam time:

{
  "type": "MONTHLY",
  "day": 10,
  "time": "20:00",
  "timeZone": "Europe/Amsterdam"
}

A recurring monthly termination that ends on the second-to-last day of each month at 16:00h Singapore time:

{
  "type": "MONTHLY",
  "day": -1,
  "time": "16:00",
  "timeZone": "Asia/Singapore"
}

A relative termination that ends 12 months after the subscription starts:

{
  "type": "RELATIVE",
  "duration": "P12M"
}

Field	Type	Description
`type` required	String	The type of the subscription termination. `ONE-OFF`, `ANNUAL`, `MONTHLY` or `RELATIVE`.
`day` optional	Integer	The day of the month, for one-off, annual and monthly terminations. For monthly terminations, 0 or negative numbers can be used, to indicate the last day of the month (`0`), the second-last day of the month (`-1`), etc.
`month` optional	Integer	The month, for one-off and annual terminations. Values range from 1 to 12.
`year` optional	Integer	The year, for one-off terminations.
`time` optional	String	The time, for one-off, annual and monthly terminations. The format is `HH:MM`, using 24-hour notation.
`timeZone` optional	String	The time zone, for one-off, annual and monthly terminations. Values are as defined by the 🔗 IANA Time Zone Database. This document provides a full list of time zone IDs.
`duration` optional	String	The maximum duration, for relative terminations. Subscriptions will end automatically when they exist for this period of time. The duration is specified in 🔗 ISO-8601 format, without a time component.

Last updated on 2025-04-18