GET
/
subscription-packages
Packages
curl --request GET \
  --url https://api.marzipan.co/v1/subscription-packages \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

type
enum<string>

Filter by subscription type (picknmix, variable)

Available options:
picknmix,
variable
collection
string

Filter packages by collection slug or name

attr
object

Filter packages by attributes using deep object notation

sort
string

Sort packages by field and direction (e.g., price.asc, name.desc)

limit
integer

Limit the number of results returned

Required range: x >= 1
page
integer

Page number for pagination

Required range: x >= 1
per_page
integer

Number of items per page

Required range: x >= 1
include
string

Include additional data. Available: attributes, subscribers

Response

200 - application/json

Success

The response is of type object.