# ContractPlanLookupDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The minimum a plan picker needs: what to show, and what it costs today.

## Fields
- `id` (string(uuid)): The plan's identifier, which is what a contract stores.
- `merchantId` (string(uuid)): The merchant that owns the plan.
- `name` (string): The plan's operator-facing name. (nullable)
- `code` (string): The merchant's own short code for the plan, or null. (nullable)
- `currencyCode` (string): The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable)
- `isActive` (boolean): Whether the plan is still open to new subscriptions. Normally true: the picker lists active plans. It is false only for a plan pulled in by `includePlanId`, which is how a contract already subscribed to a retired plan keeps showing what it is on.
- `isDeleted` (boolean): Whether the plan has been deleted. Only ever true for a plan pulled in by `includePlanId`. A deleted plan cannot price anything: the billing engine refuses to charge a contract it cannot read a plan for, and that refusal is the point of deleting one. It is carried here so the contract that is still pointing at it says so, instead of the picker quietly showing no plan at all.
- `currentTotalAmount` (number(double)): What a subscriber is charged per cycle today: the revision in force at the moment the picker was loaded. A plan carrying a scheduled change still shows today's price here, because that is what a contract created now would first bill.
- `trialDays` (integer(int32)): The trial length a new contract on this plan inherits, in days, or null when the plan offers no trial. The contract form seeds its trial end date from it when the plan is picked. (nullable)
- `defaultSchedule` ([ContractSchedule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractSchedule.md)): The recurrence a new contract on this plan starts from, or null when the plan suggests none. A suggestion only: the contract owns its schedule once created, and changing the plan's never moves an existing subscriber.
  Fields:
  - `frequency` ([Frequency](https://devportal.signapay-sbx.winkpg.io/docs/api/models/Frequency.md)): The type of the recurrence rule.
    Values:
    - `Secondly`
    - `Minutely`
    - `Hourly`
    - `Daily`
    - `Weekly`
    - `Monthly`
    - `Yearly`
  - `count` (integer(int32)): The number of occurrences in a particular recurrence. (nullable)
  - `until` (string(date-time)): The datetime that bounds the current recurrence. (nullable)
  - `interval` (integer(int32)): The recurrence interval.
  - `bySecond` (array<integer(int32)>): BySecond rule modifier. (nullable)
  - `byMinute` (array<integer(int32)>): BySecond rule modifier. (nullable)
  - `byHour` (array<integer(int32)>): BySecond rule modifier. (nullable)
  - `byDay` (array<[ContractScheduleByDayRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable)
  - `byMonth` (array<integer(int32)>): Month day rule modifier. (nullable)
  - `byMonthDay` (array<integer(int32)>): Month days rule modifier. (nullable)
  - `byYearDay` (array<integer(int32)>): Year days rule modifier. (nullable)
  - `byWeekNumber` (array<integer(int32)>): Week number rule modifier. (nullable)
  - `bySetPosition` (array<integer(int32)>): BySetPosition rule modifier. (nullable)
  - `firstDayOfWeek` ([DayOfWeek](https://devportal.signapay-sbx.winkpg.io/docs/api/models/DayOfWeek.md)): The first day of week, used in calculating weekday-based recurrences (nullable)
    Values:
    - `Sunday`
    - `Monday`
    - `Tuesday`
    - `Wednesday`
    - `Thursday`
    - `Friday`
    - `Saturday`
  - `nextScheduledRun` (string(date-time)): The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. (nullable)
  - `startDate` (string(date-time)): The earliest date on which this contract is eligible to bill. Set by the user when creating the contract (defaults to the creation date) and may be set to a future date to delay first billing. The recurrence engine anchors expansion to this date and the daily billing job will not fire a contract whose `startDate` is in the future.              Null on contracts created before this field existed. When it is null, the server anchors the schedule on the contract's creation time, or on the current time when that is also absent; callers that compute a schedule themselves should apply the same fallback. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.