PauseSubscription

Type: schema

TypeScript Definition

PauseSubscription: {{
            /**
             * @description To pause an active subscription.
             * @constant
             */
            command: "pause";
            /**
             * Format: date-time
             * @description optional. if specified, subscription will be paused from this date & time. If not specified, subscription will be paused immediately. datetime value should be greater than current time.
             */
            pause_start_date?: string;
            /**
             * Format: date-time
             * @description optional. if specified, subscription will be activated automatically from this date & time. If not specified, subscription will remain paused. datetime value should be greater than current time.
             */
            pause_end_date?: string;
        };
        /** @enum {string} */
}

OpenAPI Schema

{
  "title": "PauseSubscription",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PauseSubscription",
    "description": "API reference for the PauseSubscription schema"
  },
  "required": [
    "command"
  ],
  "properties": {
    "command": {
      "description": "To pause an active subscription.",
      "type": "string",
      "const": "pause"
    },
    "pause_start_date": {
      "description": "optional. if specified, subscription will be paused from this date & time. If not specified, subscription will be paused immediately. datetime value should be greater than current time.",
      "type": "string",
      "format": "date-time"
    },
    "pause_end_date": {
      "description": "optional. if specified, subscription will be activated automatically from this date & time. If not specified, subscription will remain paused. datetime value should be greater than current time.",
      "type": "string",
      "format": "date-time"
    }
  },
  "x-tags": [
    "Subscriptions"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions