CreateStandardSubscription

Type: schema

TypeScript Definition

CreateStandardSubscription: {{
            /** @constant */
            readonly plan_type: "standard";
            /** @constant */
            readonly plan_id: "standard";
            /** Format: date */
            start_date?: string;
            /**
             * Format: date
             * @description if specified, subscrition will be revoked on this date.
             */
            end_date?: string | null;
            coupon_code?: string | null;
        };
        /** CreateSubscription */
}

OpenAPI Schema

{
  "title": "CreateStandardSubscription",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreateStandardSubscription",
    "description": "API reference for the CreateStandardSubscription schema"
  },
  "required": [
    "plan_type",
    "plan_id"
  ],
  "properties": {
    "plan_type": {
      "type": "string",
      "const": "standard",
      "readOnly": true
    },
    "plan_id": {
      "type": "string",
      "const": "standard",
      "readOnly": true
    },
    "start_date": {
      "type": "string",
      "format": "date"
    },
    "end_date": {
      "description": "if specified, subscrition will be revoked on this date.",
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "coupon_code": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "x-tags": [
    "Subscriptions"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions