> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marzipan.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Package

> Get detailed information about a specific subscription package by its unique identifier (UUID) or slug.



## OpenAPI

````yaml /api-reference/openapi.json get /subscription-packages/{packageId}
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
  - name: Settings
    description: >-
      Storefront settings and market detection used to configure the web
      components and checkout.
  - name: Analytics
    description: Storefront visit and attribution tracking.
  - name: Rewards
    description: >-
      Loyalty and rewards programme endpoints for the authenticated customer,
      covering points balance, tier status, perks, exclusive products and
      transaction history.
  - name: Forms
    description: Render and submit dynamic storefront forms defined in the CMS.
  - name: Events
    description: >-
      Check event availability, browse occurrences and recurring dates, generate
      ticket QR codes, and manage event waitlists (join, leave, check status,
      and claim promoted spots).
paths:
  /subscription-packages/{packageId}:
    parameters:
      - name: packageId
        in: path
        required: true
        description: The unique identifier (UUID) or slug for the subscription package
        schema:
          type: string
        examples:
          uuid:
            value: 550e8400-e29b-41d4-a716-446655440000
            description: Using a UUID
          slug:
            value: discovery-club
            description: Using a slug
    get:
      tags:
        - Subscriptions
      summary: Package
      description: >-
        Get detailed information about a specific subscription package by its
        unique identifier (UUID) or slug.
      parameters:
        - name: include
          in: query
          required: false
          description: 'Include additional data. Available: subscribers'
          schema:
            type: string
            enum:
              - subscribers
      responses:
        '200':
          description: Subscription package details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPackage'
              example:
                id: 084b80ef-d16d-4531-a25f-40b7ff4c744b
                subscriptionType: variable
                name: Discovery Club
                slug: discovery-club
                sku: DISCCLUB
                url: https://api.marzipan.co/subscription-packages/discovery-club
                status: active
                availability: all
                productType: subscription
                description: >-
                  Laborum adipiscing, tempor cillum. Cillum exercitation sed
                  officia mollit do dolore. Sed officia mollit do dolore do ex
                  officia mollit. Mollit irure adipiscing ipsum id lorem sunt.
                  Ipsum id lorem sunt dolore magna aliqua.
                metaTitle: Discovery Club - Premium Wine Subscription
                metaDescription: >-
                  Join our Discovery Club and explore exceptional wines
                  delivered monthly to your door.
                collections:
                  - id: 46759fdd-1b5b-4339-a175-af0569c1ca73
                    name: Club
                    slug: club
                    description: Club products
                images:
                  - id: bc1a0d61-e7f9-44d3-ae53-1475b5f9395d
                    path: 1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                    src: >-
                      https://marzipan-cloud-dev.b-cdn.net/1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                    alt: Discovery Club subscription box
                    mimeType: image/jpeg
                    filename: bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                primaryImage:
                  id: bc1a0d61-e7f9-44d3-ae53-1475b5f9395d
                  path: 1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                  src: >-
                    https://marzipan-cloud-dev.b-cdn.net/1/bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                  alt: Discovery Club subscription box
                  mimeType: image/jpeg
                  filename: bc1a0d61-e7f9-44d3-ae53-1475b5f9395d.jpg
                price:
                  value: 0
                  formatted: £0.00
                  currency: GBP
                salePrice: null
                billingFrequency: 6
                billingFrequencies:
                  - 1
                  - 3
                  - 6
                  - 12
                pricingType: per_item
                autoRenew: true
                minimumItems: 2
                availableItems:
                  - itemId: 2e2805a1-738e-4118-8a8b-f9431f0e210c
                    itemName: Cellar Selection Malbec
                    itemSku: CSMALBC2015
                    itemDescription: Premium Malbec with rich, full-bodied flavor profile
                    minQty: 1
                    maxQty: 3
                    defaultQty: 1
                    sortOrder: 1
                    status: active
                  - itemId: df0d13db-1332-4461-b3d1-b2774d47ff5f
                    itemName: Chardonnay
                    itemSku: CHARD2015
                    itemDescription: Elegant white wine with crisp citrus notes
                    minQty: 1
                    maxQty: 2
                    defaultQty: 1
                    sortOrder: 2
                    status: active
                attributes: []
                options: []
                relatedProducts: []
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: string
components:
  schemas:
    SubscriptionPackage:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the subscription package
        subscriptionType:
          type: string
          enum:
            - picknmix
            - variable
          description: Type of subscription package
        name:
          type: string
          description: Package name
        slug:
          type: string
          description: URL-friendly package identifier
        sku:
          type: string
          description: Stock Keeping Unit
        url:
          type: string
          description: Full URL to the package page
        status:
          type: string
          enum:
            - active
            - inactive
            - out_of_stock
          description: Package status
        availability:
          type: string
          enum:
            - all
            - subscribers
          description: Who can purchase this package
        productType:
          type: string
          enum:
            - subscription
          description: Always 'subscription' for packages
        description:
          type: string
          description: Package description
        metaTitle:
          type: string
          description: SEO meta title
        metaDescription:
          type: string
          description: SEO meta description
        collections:
          type: array
          items:
            $ref: '#/components/schemas/Collection'
          description: Collections this package belongs to
        images:
          type: array
          items:
            $ref: '#/components/schemas/ProductImage'
          description: Package images
        primaryImage:
          $ref: '#/components/schemas/ProductImage'
          description: Primary package image
        price:
          type: object
          properties:
            value:
              type: integer
              description: Price in cents
            formatted:
              type: string
              description: Formatted price with currency
            currency:
              type: string
              description: Currency code
          description: Package price information
        salePrice:
          type: object
          nullable: true
          properties:
            value:
              type: integer
              description: Sale price in cents
            formatted:
              type: string
              description: Formatted sale price with currency
            currency:
              type: string
              description: Currency code
          description: Sale price information if on sale
        billingFrequency:
          type: integer
          description: Default billing frequency in months
        billingFrequencies:
          type: array
          items:
            type: integer
          description: Available billing frequencies in months
        pricingType:
          type: string
          enum:
            - fixed
            - per_item
          description: How the subscription is priced
        autoRenew:
          type: boolean
          description: Whether the subscription auto-renews
        minimumItems:
          type: integer
          description: Minimum number of items required for pick & mix
        availableItems:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionAvailableItem'
          description: >-
            Available items for pick & mix subscriptions. Only present for
            picknmix type
        attributes:
          type: array
          items:
            type: object
          description: Package attributes
        options:
          type: array
          items:
            type: object
          description: Package options
        relatedProducts:
          type: array
          items:
            type: object
          description: Related products
        subscribers:
          type: integer
          description: >-
            Number of subscribers. Only included when using ?include=subscribers
            parameter
    Collection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the collection
        name:
          type: string
          description: Collection name
        description:
          type: string
          description: Collection description
        slug:
          type: string
          description: URL-friendly collection identifier
        attributes:
          type: array
          items:
            type: object
          description: Collection attributes
    ProductImage:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the image
        path:
          type: string
          description: Relative path to the image file
        src:
          type: string
          format: uri
          description: Full URL to access the image
        alt:
          type: string
          nullable: true
          description: Alternative text for accessibility
        mimeType:
          type: string
          description: MIME type of the image (e.g., image/jpeg, image/png)
        filename:
          type: string
          description: Original filename of the uploaded image
    SubscriptionAvailableItem:
      type: object
      properties:
        itemId:
          type: string
          format: uuid
          description: Product ID of the available item
        itemName:
          type: string
          description: Name of the available item
        itemSku:
          type: string
          description: SKU of the available item
        itemDescription:
          type: string
          description: Description of the available item
        minQty:
          type: integer
          description: Minimum quantity allowed
        maxQty:
          type: integer
          description: Maximum quantity allowed
        defaultQty:
          type: integer
          description: Default quantity
        sortOrder:
          type: integer
          description: Display order
        image:
          $ref: '#/components/schemas/ProductImage'
          description: Primary item image
        collections:
          type: array
          items:
            $ref: '#/components/schemas/Collection'
          description: Collections this item belongs to
        status:
          type: string
          enum:
            - active
            - inactive
            - out_of_stock
          description: Item availability status
        attributes:
          type: array
          items:
            type: object
          description: Item attributes
        relatedProducts:
          type: array
          items:
            type: object
          description: Related products
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````