GET
/
subscription-packages
/
{packageId}
Package
curl --request GET \
  --url https://api.marzipan.co/v1/subscription-packages/{packageId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "084b80ef-d16d-4531-a25f-40b7ff4c744b",
  "subscription_type": "variable",
  "name": "Discovery Club",
  "slug": "discovery-club",
  "sku": "DISCCLUB",
  "url": "https://api.marzipan.co/subscription-packages/discovery-club",
  "status": "active",
  "availability": "all",
  "product_type": "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.",
  "meta_title": "Discovery Club - Premium Wine Subscription",
  "meta_description": "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,
  "billing_frequency": 6,
  "billing_frequencies": [
    1,
    3,
    6,
    12
  ],
  "pricing_type": "per_item",
  "auto_renew": true,
  "minimum_items": 2,
  "available_items": [
    {
      "item_id": "2e2805a1-738e-4118-8a8b-f9431f0e210c",
      "item_name": "Cellar Selection Malbec",
      "item_sku": "CSMALBC2015",
      "item_description": "Premium Malbec with rich, full-bodied flavor profile",
      "min_qty": 1,
      "max_qty": 3,
      "default_qty": 1,
      "sort_order": 1,
      "status": "active"
    },
    {
      "item_id": "df0d13db-1332-4461-b3d1-b2774d47ff5f",
      "item_name": "Chardonnay",
      "item_sku": "CHARD2015",
      "item_description": "Elegant white wine with crisp citrus notes",
      "min_qty": 1,
      "max_qty": 2,
      "default_qty": 1,
      "sort_order": 2,
      "status": "active"
    }
  ],
  "attributes": [],
  "options": [],
  "related_products": []
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

packageId
string
required

The unique identifier (UUID) or slug for the subscription package

Query Parameters

include
enum<string>

Include additional data. Available: subscribers

Available options:
subscribers

Response

Subscription package details

id
string<uuid>

Unique identifier for the subscription package

subscription_type
enum<string>

Type of subscription package

Available options:
picknmix,
variable
name
string

Package name

slug
string

URL-friendly package identifier

sku
string

Stock Keeping Unit

url
string

Full URL to the package page

status
enum<string>

Package status

Available options:
active,
inactive,
out_of_stock
availability
enum<string>

Who can purchase this package

Available options:
all,
subscribers
product_type
enum<string>

Always 'subscription' for packages

Available options:
subscription
description
string

Package description

meta_title
string

SEO meta title

meta_description
string

SEO meta description

collections
object[]

Collections this package belongs to

images
object[]

Package images

primaryImage
object

Primary package image

price
object

Package price information

salePrice
object | null

Sale price information if on sale

billing_frequency
integer

Default billing frequency in months

billing_frequencies
integer[]

Available billing frequencies in months

pricing_type
enum<string>

How the subscription is priced

Available options:
fixed,
per_item
auto_renew
boolean

Whether the subscription auto-renews

minimum_items
integer

Minimum number of items required for pick & mix

available_items
object[]

Available items for pick & mix subscriptions. Only present for picknmix type

attributes
object[]

Package attributes

options
object[]

Package options

Related products

subscribers
integer

Number of subscribers. Only included when using ?include=subscribers parameter