Skip to content

RevokeSubscription

Type: schema

TypeScript Definition

typescript
RevokeSubscription: {{
            /**
             * @description To revoke a subscription.
             * @constant
             */
            command: "revoke";
            /** @description Provide reason for revoking subscription. */
            reason: string;
        };
        /** SavedPaymentMethod */
}

OpenAPI Schema

json
{
  "title": "RevokeSubscription",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/RevokeSubscription",
    "description": "API reference for the RevokeSubscription schema"
  },
  "required": [
    "command",
    "reason"
  ],
  "properties": {
    "command": {
      "description": "To revoke a subscription.",
      "type": "string",
      "const": "revoke"
    },
    "reason": {
      "description": "Provide reason for revoking subscription.",
      "type": "string"
    }
  },
  "x-tags": [
    "Subscriptions"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: