> ## 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.

# Packages

> List all available subscription packages including pricing and subscription type information. Supports filtering and sorting similar to products endpoint.



## OpenAPI

````yaml api-reference/openapi.json get /subscription-packages
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
paths:
  /subscription-packages:
    parameters: []
    get:
      tags:
        - Subscriptions
      summary: Packages
      description: >-
        List all available subscription packages including pricing and
        subscription type information. Supports filtering and sorting similar to
        products endpoint.
      parameters:
        - name: type
          in: query
          required: false
          description: Filter by subscription type (picknmix, variable)
          schema:
            type: string
            enum:
              - picknmix
              - variable
        - name: collection
          in: query
          required: false
          description: Filter packages by collection slug or name
          schema:
            type: string
        - name: attr
          in: query
          required: false
          description: Filter packages by attributes using deep object notation
          schema:
            type: object
            additionalProperties:
              type: string
          style: deepObject
          explode: true
        - name: sort
          in: query
          required: false
          description: Sort packages by field and direction (e.g., price.asc, name.desc)
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Limit the number of results returned
          schema:
            type: integer
            minimum: 1
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
            minimum: 1
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
            minimum: 1
        - name: include
          in: query
          required: false
          description: 'Include additional data. Available: attributes, subscribers'
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SubscriptionPackageCollection'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        format: uri
                      last:
                        type: string
                        format: uri
                        nullable: true
                      prev:
                        type: string
                        format: uri
                        nullable: true
                      next:
                        type: string
                        format: uri
                        nullable: true
                  meta:
                    type: object
                    properties:
                      currentPage:
                        type: integer
                      from:
                        type: integer
                      path:
                        type: string
                        format: uri
                      perPage:
                        type: integer
                      to:
                        type: integer
              example:
                data:
                  - id: 084b80ef-d16d-4531-a25f-40b7ff4c744b
                    subscriptionType: variable
                    name: Discovery Club
                    slug: discovery-club
                    subscriptions_slug: club
                    url: >-
                      https://api.marzipan.co/subscription-packages/discovery-club
                    description: >-
                      Laborum adipiscing, tempor cillum. Cillum exercitation sed
                      officia mollit do dolore. Sed officia mollit do dolore do
                      ex.
                    product_type: subscription
                    sku: DISCCLUB
                    collection: Club
                    status: active
                    image:
                      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
                    created_at: '2024-02-05T23:22:56.000000Z'
                    updated_at: '2024-02-05T23:22:56.000000Z'
                links:
                  first: https://api.marzipan.co/v1/subscription-packages?page=1
                  last: https://api.marzipan.co/v1/subscription-packages?page=1
                  prev: null
                  next: null
                meta:
                  currentPage: 1
                  from: 1
                  path: https://api.marzipan.co/v1/subscription-packages
                  perPage: 15
                  to: 1
components:
  schemas:
    SubscriptionPackageCollection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the subscription package
        subscription_type:
          type: string
          enum:
            - picknmix
            - variable
          description: Type of subscription package
        name:
          type: string
          description: Package name
        slug:
          type: string
          description: URL-friendly package identifier
        subscriptions_slug:
          type: string
          description: Subscriptions URL slug
        url:
          type: string
          description: Full URL to the package page
        description:
          type: string
          description: Package description
        product_type:
          type: string
          enum:
            - subscription
          description: Always 'subscription' for packages
        sku:
          type: string
          description: Stock Keeping Unit
        collection:
          type: string
          nullable: true
          description: Primary collection name
        status:
          type: string
          enum:
            - active
            - inactive
            - out_of_stock
          description: Package status
        image:
          $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
        attributes:
          type: array
          items:
            type: object
          description: >-
            Package attributes. Only included when using ?include=attributes
            parameter
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
    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
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````