# POST /api/contract-plans Create a ContractPlan Create a new ContractPlan **Operation ID:** `contractPlansCreate` ## Authorization Requires: Customers.ContractPlans, Customers.ContractPlans.Create, merchant scope. Requires API key scope: `admin` Required permissions: - `Customers.ContractPlans` - `Customers.ContractPlans.Create` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: [`ContractPlanCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanCreateDto.md) Properties: - `merchantId` (string(uuid)) required: The merchant that owns the plan. (nullable) - `name` (string) required: The plan's operator-facing name. Must be unique within the owning merchant. (nullable, max length 128) - `code` (string): The merchant's own short code for the plan. Optional, and not resolved by the platform. (nullable, max length 64) - `description` (string): What the plan covers, in the operator's own words. (nullable, max length 1024) - `currencyCode` (string) required: The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$) - `isActive` (boolean): Whether the plan may be subscribed to. Turning it off hides it from the plan picker and blocks new subscriptions; it does not stop billing the contracts already on it. - `defaultSchedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md)): The recurrence a new contract on this plan starts from. Optional, and a suggestion only: the contract owns its schedule once created. Fields: - `frequency` ([Frequency](https://devportal.demo.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): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.demo.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) - `trialDays` (integer(int32)): The trial length a new contract on this plan inherits, in days. Optional; empty or zero means no trial. A default for contract creation only: each contract owns its own trial end date once created, and changing this never moves an existing subscriber. (nullable, min 0, max 365) - `billSubtotalAmount` (number(double)): The base amount the plan charges each cycle, before tax. (min 0) - `taxAmount` (number(double)): The tax added to the base amount each cycle. Leave empty when the plan carries no tax line. (nullable, min 0) - `totalAmount` (number(double)): The total charged to a subscriber each cycle. This is the amount the billing engine charges; the subtotal and tax are the operator's breakdown of it. (greater than 0) _Example: Plan without a trial_ Adds a plan that charges subscribers 129.90 a month (120.00 plus 9.90 of tax). The opening price is in force from the moment the plan exists; change it later with POST /api/contract-plans/{id}/prices, which keeps every earlier price. The name must be unique within the merchant. The default schedule only seeds a new contract's recurrence, and each contract owns its schedule once created. ```json { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } ``` _Example: Plan with a 14-day trial_ Adds a 49.00 monthly plan whose new subscribers start on a 14-day trial: a contract created on the plan with no trial end date of its own is not charged until the trial ends. The trial is a default for new contracts only, so changing it later never moves an existing subscriber. ```json { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } ``` **Content type:** `text/json` Schema: [`ContractPlanCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanCreateDto.md) Properties: - `merchantId` (string(uuid)) required: The merchant that owns the plan. (nullable) - `name` (string) required: The plan's operator-facing name. Must be unique within the owning merchant. (nullable, max length 128) - `code` (string): The merchant's own short code for the plan. Optional, and not resolved by the platform. (nullable, max length 64) - `description` (string): What the plan covers, in the operator's own words. (nullable, max length 1024) - `currencyCode` (string) required: The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$) - `isActive` (boolean): Whether the plan may be subscribed to. Turning it off hides it from the plan picker and blocks new subscriptions; it does not stop billing the contracts already on it. - `defaultSchedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md)): The recurrence a new contract on this plan starts from. Optional, and a suggestion only: the contract owns its schedule once created. Fields: - `frequency` ([Frequency](https://devportal.demo.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): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.demo.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) - `trialDays` (integer(int32)): The trial length a new contract on this plan inherits, in days. Optional; empty or zero means no trial. A default for contract creation only: each contract owns its own trial end date once created, and changing this never moves an existing subscriber. (nullable, min 0, max 365) - `billSubtotalAmount` (number(double)): The base amount the plan charges each cycle, before tax. (min 0) - `taxAmount` (number(double)): The tax added to the base amount each cycle. Leave empty when the plan carries no tax line. (nullable, min 0) - `totalAmount` (number(double)): The total charged to a subscriber each cycle. This is the amount the billing engine charges; the subtotal and tax are the operator's breakdown of it. (greater than 0) _Example: Plan without a trial_ Adds a plan that charges subscribers 129.90 a month (120.00 plus 9.90 of tax). The opening price is in force from the moment the plan exists; change it later with POST /api/contract-plans/{id}/prices, which keeps every earlier price. The name must be unique within the merchant. The default schedule only seeds a new contract's recurrence, and each contract owns its schedule once created. ```json { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } ``` _Example: Plan with a 14-day trial_ Adds a 49.00 monthly plan whose new subscribers start on a 14-day trial: a contract created on the plan with no trial end date of its own is not charged until the trial ends. The trial is a default for new contracts only, so changing it later never moves an existing subscriber. ```json { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } ``` **Content type:** `application/*+json` Schema: [`ContractPlanCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanCreateDto.md) Properties: - `merchantId` (string(uuid)) required: The merchant that owns the plan. (nullable) - `name` (string) required: The plan's operator-facing name. Must be unique within the owning merchant. (nullable, max length 128) - `code` (string): The merchant's own short code for the plan. Optional, and not resolved by the platform. (nullable, max length 64) - `description` (string): What the plan covers, in the operator's own words. (nullable, max length 1024) - `currencyCode` (string) required: The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$) - `isActive` (boolean): Whether the plan may be subscribed to. Turning it off hides it from the plan picker and blocks new subscriptions; it does not stop billing the contracts already on it. - `defaultSchedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md)): The recurrence a new contract on this plan starts from. Optional, and a suggestion only: the contract owns its schedule once created. Fields: - `frequency` ([Frequency](https://devportal.demo.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): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.demo.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) - `trialDays` (integer(int32)): The trial length a new contract on this plan inherits, in days. Optional; empty or zero means no trial. A default for contract creation only: each contract owns its own trial end date once created, and changing this never moves an existing subscriber. (nullable, min 0, max 365) - `billSubtotalAmount` (number(double)): The base amount the plan charges each cycle, before tax. (min 0) - `taxAmount` (number(double)): The tax added to the base amount each cycle. Leave empty when the plan carries no tax line. (nullable, min 0) - `totalAmount` (number(double)): The total charged to a subscriber each cycle. This is the amount the billing engine charges; the subtotal and tax are the operator's breakdown of it. (greater than 0) _Example: Plan without a trial_ Adds a plan that charges subscribers 129.90 a month (120.00 plus 9.90 of tax). The opening price is in force from the moment the plan exists; change it later with POST /api/contract-plans/{id}/prices, which keeps every earlier price. The name must be unique within the merchant. The default schedule only seeds a new contract's recurrence, and each contract owns its schedule once created. ```json { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } ``` _Example: Plan with a 14-day trial_ Adds a 49.00 monthly plan whose new subscribers start on a 14-day trial: a contract created on the plan with no trial end date of its own is not charged until the trial ends. The trial is a default for new contracts only, so changing it later never moves an existing subscriber. ```json { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } ``` ## Responses ### 200 OK **Content type:** `application/json` Schema: [`ContractPlanDto`](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanDto.md) Properties: - `id` (string(uuid)) - `creationTime` (string(date-time)): The date and time when this entity was created. - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable) - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable) - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable) - `isDeleted` (boolean): Indicates whether this entity has been deleted. - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable) - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable) - `merchantId` (string(uuid)): The merchant that owns the plan. - `tenantId` (string(uuid)): The tenant that owns the plan. Null for host-level plans. (nullable) - `name` (string): The plan's operator-facing name, unique within the owning merchant. (nullable) - `code` (string): The merchant's own short code for the plan, or null. Not resolved by the platform. (nullable) - `description` (string): What the plan covers, in the operator's own words. (nullable) - `currencyCode` (string): The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable) - `isActive` (boolean): Whether the plan may be subscribed to. An inactive plan keeps pricing the contracts already on it. - `defaultSchedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md)): The recurrence a new contract on this plan starts from, or null when the plan suggests none. Fields: - `frequency` ([Frequency](https://devportal.demo.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): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.demo.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) - `trialDays` (integer(int32)): The trial length a new contract on this plan inherits, in days, or null when the plan offers no trial. (nullable) - `currentPrice` ([ContractPlanPriceDto](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceDto.md)): The plan's price today: the revision in force at the moment the plan was read, with no scheduled run to measure a next-cycle change against. Fields: - `id` (string(uuid)): Identifies this revision. - `billSubtotalAmount` (number(double)): The base amount charged each cycle, before tax. - `taxAmount` (number(double)): The tax added to the base amount each cycle, or null when the plan carries no tax line. (nullable) - `totalAmount` (number(double)): The total charged to the subscriber's payment method each cycle. - `effectiveFrom` (string(date-time)): The moment this revision starts applying, in UTC. - `policy` ([ContractPlanPriceChangePolicy](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceChangePolicy.md)): The propagation policy the revision was saved under. Values: - `Immediate`: The new price applies to every charge executed from the moment the change was saved, including a charge that was already due and has not run yet. - `NextCycle`: The new price applies only to charges that fall due after the change was saved. A charge that was already due when the price changed still bills at the old price, so a subscriber is never re-priced part-way through a cycle they have already entered. - `Scheduled`: The new price applies to charges executed on or after an operator-chosen effective moment. Until then every subscriber keeps billing at the previous price. - `recordedAt` (string(date-time)): When the revision was saved, in UTC. - `recordedByUserId` (string(uuid)): The operator who saved the revision, or null when the platform wrote it. (nullable) - `note` (string): Why the price changed, in the operator's own words. (nullable) - `pendingPrice` ([ContractPlanPriceDto](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceDto.md)): The revision that will take over next, when one is scheduled and has not taken effect yet. Null when the plan has no pending change. Fields: - `id` (string(uuid)): Identifies this revision. - `billSubtotalAmount` (number(double)): The base amount charged each cycle, before tax. - `taxAmount` (number(double)): The tax added to the base amount each cycle, or null when the plan carries no tax line. (nullable) - `totalAmount` (number(double)): The total charged to the subscriber's payment method each cycle. - `effectiveFrom` (string(date-time)): The moment this revision starts applying, in UTC. - `policy` ([ContractPlanPriceChangePolicy](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceChangePolicy.md)): The propagation policy the revision was saved under. Values: - `Immediate`: The new price applies to every charge executed from the moment the change was saved, including a charge that was already due and has not run yet. - `NextCycle`: The new price applies only to charges that fall due after the change was saved. A charge that was already due when the price changed still bills at the old price, so a subscriber is never re-priced part-way through a cycle they have already entered. - `Scheduled`: The new price applies to charges executed on or after an operator-chosen effective moment. Until then every subscriber keeps billing at the previous price. - `recordedAt` (string(date-time)): When the revision was saved, in UTC. - `recordedByUserId` (string(uuid)): The operator who saved the revision, or null when the platform wrote it. (nullable) - `note` (string): Why the price changed, in the operator's own words. (nullable) - `prices` (array<[ContractPlanPriceDto](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceDto.md)>): Every price the plan has carried, oldest first. (nullable) Fields of each item: - `id` (string(uuid)): Identifies this revision. - `billSubtotalAmount` (number(double)): The base amount charged each cycle, before tax. - `taxAmount` (number(double)): The tax added to the base amount each cycle, or null when the plan carries no tax line. (nullable) - `totalAmount` (number(double)): The total charged to the subscriber's payment method each cycle. - `effectiveFrom` (string(date-time)): The moment this revision starts applying, in UTC. - `policy` ([ContractPlanPriceChangePolicy](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceChangePolicy.md)): The propagation policy the revision was saved under. Values: - `Immediate`: The new price applies to every charge executed from the moment the change was saved, including a charge that was already due and has not run yet. - `NextCycle`: The new price applies only to charges that fall due after the change was saved. A charge that was already due when the price changed still bills at the old price, so a subscriber is never re-priced part-way through a cycle they have already entered. - `Scheduled`: The new price applies to charges executed on or after an operator-chosen effective moment. Until then every subscriber keeps billing at the previous price. - `recordedAt` (string(date-time)): When the revision was saved, in UTC. - `recordedByUserId` (string(uuid)): The operator who saved the revision, or null when the platform wrote it. (nullable) - `note` (string): Why the price changed, in the operator's own words. (nullable) - `concurrencyStamp` (string): The concurrency stamp used for optimistic concurrency control. (nullable) - `entityVersion` (integer(int32)): The entity version, incremented on each modification. ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## Example request Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key. The request body is a ContractPlanCreateDto. See the Request body section below for its fields. These blocks send the Plan without a trial example. The other examples follow under Other request examples. Adds a plan that charges subscribers 129.90 a month (120.00 plus 9.90 of tax). The opening price is in force from the moment the plan exists; change it later with POST /api/contract-plans/{id}/prices, which keeps every earlier price. The name must be unique within the merchant. The default schedule only seeds a new contract's recurrence, and each contract owns its schedule once created. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/contract-plans" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contract-plans' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, ContractPlansApi } from '@winkpg/winkpg-api'; const api = new ContractPlansApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.contractPlansCreate({ "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/contract-plans', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } }), }); const data = await response.json(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp using WinkPg.Api.Client.Api; using WinkPg.Api.Client.Client; using System.Text.Json; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new ContractPlansApi(config); var body = JsonSerializer.Deserialize(""" { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } """); var result = await api.ContractPlansCreateAsync(body); ``` ### C# (raw HTTP) ```csharp using System.Text; using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/contract-plans"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } """, Encoding.UTF8, "application/json"); var response = await http.SendAsync(request); response.EnsureSuccessStatusCode(); var json = await response.Content.ReadAsStringAsync(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python import winkpg_api configuration = winkpg_api.Configuration(host="{{BASE_URL}}") configuration.api_key["ApiKey"] = "{{API_KEY}}" with winkpg_api.ApiClient(configuration) as client: api = winkpg_api.ContractPlansApi(client) body = winkpg_api.ContractPlanCreateDto.from_dict({ "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": True, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } }) result = api.contract_plans_create(body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "billSubtotalAmount": 120, "taxAmount": 9.9, "totalAmount": 129.9, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Lawn care monthly", "code": "LAWN-M", "description": "Weekly mowing, edging and cleanup, billed monthly", "currencyCode": "USD", "isActive": True, "defaultSchedule": { "frequency": "Monthly", "interval": 1 } } response = requests.request( "POST", "{{BASE_URL}}/api/contract-plans", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## Other request examples Each example below is one request, shown in every language with the same placeholders. ### Plan with a 14-day trial Adds a 49.00 monthly plan whose new subscribers start on a 14-day trial: a contract created on the plan with no trial end date of its own is not charged until the trial ends. The trial is a default for new contracts only, so changing it later never moves an existing subscriber. #### cURL ```bash curl -X POST "{{BASE_URL}}/api/contract-plans" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 }' ``` #### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contract-plans' ` -Headers $headers -ContentType 'application/json' -Body $body ``` #### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, ContractPlansApi } from '@winkpg/winkpg-api'; const api = new ContractPlansApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.contractPlansCreate({ "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 }); ``` #### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/contract-plans', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 }), }); const data = await response.json(); ``` #### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp using WinkPg.Api.Client.Api; using WinkPg.Api.Client.Client; using System.Text.Json; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new ContractPlansApi(config); var body = JsonSerializer.Deserialize(""" { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } """); var result = await api.ContractPlansCreateAsync(body); ``` #### C# (raw HTTP) ```csharp using System.Text; using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/contract-plans"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": true, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } """, Encoding.UTF8, "application/json"); var response = await http.SendAsync(request); response.EnsureSuccessStatusCode(); var json = await response.Content.ReadAsStringAsync(); ``` #### Python (SDK) ```bash pip install winkpg-api ``` ```python import winkpg_api configuration = winkpg_api.Configuration(host="{{BASE_URL}}") configuration.api_key["ApiKey"] = "{{API_KEY}}" with winkpg_api.ApiClient(configuration) as client: api = winkpg_api.ContractPlansApi(client) body = winkpg_api.ContractPlanCreateDto.from_dict({ "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": True, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 }) result = api.contract_plans_create(body) ``` #### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "billSubtotalAmount": 49, "totalAmount": 49, "merchantId": "00000000-0000-0000-0000-000000000001", "name": "Pro membership", "code": "PRO-M", "description": "Unlimited classes and one guest pass a month", "currencyCode": "USD", "isActive": True, "defaultSchedule": { "frequency": "Monthly", "interval": 1 }, "trialDays": 14 } response = requests.request( "POST", "{{BASE_URL}}/api/contract-plans", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.