update-subscription

Method: PUT
Path: /subscriptions/{id}

Tags: Subscriptions

Summary

Update a specific subscription

Description

Update a specific subscription

TypeScript Definition

"update-subscription": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description subscription id */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["UpdatePhysicalProductSubscription"] | components["schemas"]["UpdateDigitalProductSubscription"] | components["schemas"]["PauseSubscription"] | components["schemas"]["RevokeSubscription"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            subscription: components["schemas"]["SubscriptionDetail"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["UpdatePhysicalProductSubscription"]	UpdatePhysicalProductSubscription
components["schemas"]["UpdateDigitalProductSubscription"]	UpdateDigitalProductSubscription
components["schemas"]["PauseSubscription"]	PauseSubscription
components["schemas"]["RevokeSubscription"]	RevokeSubscription
components["schemas"]["SubscriptionDetail"]	SubscriptionDetail
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Subscriptions"
  ],
  "operationId": "update-subscription",
  "summary": "Update a specific subscription",
  "description": "Update a specific subscription",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/update-subscription",
    "description": "API reference for the update-subscription operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/UpdatePhysicalProductSubscription"
            },
            {
              "$ref": "#/components/schemas/UpdateDigitalProductSubscription"
            },
            {
              "$ref": "#/components/schemas/PauseSubscription"
            },
            {
              "$ref": "#/components/schemas/RevokeSubscription"
            }
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "subscription": {
                    "$ref": "#/components/schemas/SubscriptionDetail"
                  }
                },
                "required": [
                  "subscription"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "x-speakeasy-group": "subscriptions",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "updateSubscription"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions