CreateSubscription

Type: schema

TypeScript Definition

CreateSubscription: {(components["schemas"]["CreateStandardSubscription"] | components["schemas"]["CreateCustomSubscription"]) & components["schemas"]["SubscriptionBehaviour"] & {
            invoice_items: components["schemas"]["SubscriptionInvoiceItem"][]
}

Component References

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

OpenAPI Schema

{
  "title": "CreateSubscription",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreateSubscription",
    "description": "API reference for the CreateSubscription schema"
  },
  "allOf": [
    {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CreateStandardSubscription"
        },
        {
          "$ref": "#/components/schemas/CreateCustomSubscription"
        }
      ]
    },
    {
      "$ref": "#/components/schemas/SubscriptionBehaviour"
    },
    {
      "type": "object",
      "required": [
        "invoice_items"
      ],
      "properties": {
        "invoice_items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SubscriptionInvoiceItem"
          }
        }
      }
    }
  ],
  "x-tags": [
    "Subscriptions"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions