Skip to content

SubscriptionInvoiceItem

Type: schema

TypeScript Definition

typescript
SubscriptionInvoiceItem: {{
            product_id: string;
            variant_id: string | null;
            product_name: $Read<string>;
            variant_name: $Read<string>;
            product_image_url: $Read<string>;
            sku: $Read<string>;
            quantity: number;
            /** Format: double */
            listing_price: $Read<number>;
            /** Format: double */
            selling_price: $Read<number>;
            /** @constant */
            tax_type: $Read<"GST">;
            /** Format: double */
            tax_rate: $Read<number>;
            price_including_tax: $Read<boolean>;
            /** Format: double */
            selling_price_excluding_tax: $Read<number>;
        };
        /**
         * TextAttribute
         * @description Attribute for text values
         */
}

OpenAPI Schema

json
{
  "title": "SubscriptionInvoiceItem",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/SubscriptionInvoiceItem",
    "description": "API reference for the SubscriptionInvoiceItem schema"
  },
  "required": [
    "product_id",
    "variant_id",
    "product_name",
    "variant_name",
    "product_image_url",
    "sku",
    "quantity",
    "listing_price",
    "selling_price",
    "tax_type",
    "tax_rate",
    "price_including_tax",
    "selling_price_excluding_tax"
  ],
  "properties": {
    "product_id": {
      "type": "string"
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "variant_name": {
      "type": "string",
      "readOnly": true
    },
    "product_image_url": {
      "type": "string",
      "readOnly": true
    },
    "sku": {
      "type": "string",
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "listing_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "selling_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "tax_type": {
      "type": "string",
      "const": "GST",
      "readOnly": true
    },
    "tax_rate": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "price_including_tax": {
      "type": "boolean",
      "readOnly": true
    },
    "selling_price_excluding_tax": {
      "type": "number",
      "format": "double",
      "readOnly": true
    }
  },
  "x-tags": [
    "Subscriptions"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: