UpdateDigitalProductSubscription

Type: schema

TypeScript Definition

UpdateDigitalProductSubscription: {{
            /** @constant */
            command: "update";
            /** @enum {unknown} */
            billing_frequency?: "monthly";
            /** @default 1 */
            billing_interval: number;
            /** @description null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached. */
            billing_limit?: number | null;
        } & components["schemas"]["SubscriptionBehaviour"] & {
            invoice_items?: components["schemas"]["SubscriptionInvoiceItem"][];
        };
        /** UpdateDocument */
}

Component References

Reference	Resolves To
components["schemas"]["SubscriptionBehaviour"]	SubscriptionBehaviour
components["schemas"]["SubscriptionInvoiceItem"]	SubscriptionInvoiceItem

OpenAPI Schema

{
  "title": "UpdateDigitalProductSubscription",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/UpdateDigitalProductSubscription",
    "description": "API reference for the UpdateDigitalProductSubscription schema"
  },
  "allOf": [
    {
      "type": "object",
      "required": [
        "command"
      ],
      "properties": {
        "command": {
          "type": "string",
          "const": "update"
        },
        "billing_frequency": {
          "enum": [
            "monthly"
          ]
        },
        "billing_interval": {
          "type": "integer",
          "default": 1
        },
        "billing_limit": {
          "description": "null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.",
          "type": [
            "integer",
            "null"
          ]
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubscriptionBehaviour"
    },
    {
      "type": "object",
      "properties": {
        "invoice_items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SubscriptionInvoiceItem"
          }
        }
      }
    }
  ],
  "x-tags": [
    "Subscriptions"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions