curl --request GET \
--url https://api.marzipan.co/v1/subscription-packages/{packageId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.marzipan.co/v1/subscription-packages/{packageId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.marzipan.co/v1/subscription-packages/{packageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.marzipan.co/v1/subscription-packages/{packageId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.marzipan.co/v1/subscription-packages/{packageId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.marzipan.co/v1/subscription-packages/{packageId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.marzipan.co/v1/subscription-packages/{packageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "084b80ef-d16d-4531-a25f-40b7ff4c744b",
"subscriptionType": "variable",
"name": "Discovery Plan",
"slug": "discovery-plan",
"sku": "DISCPLAN",
"url": "https://api.marzipan.co/subscription-packages/discovery-plan",
"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 Plan - Premium Subscription",
"metaDescription": "Join our Discovery Plan and get an exceptional selection delivered monthly to your door.",
"collections": [
{
"id": "46759fdd-1b5b-4339-a175-af0569c1ca73",
"name": "Subscriptions",
"slug": "subscriptions",
"description": "Subscription 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 Plan 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 Plan 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": "Signature Selection",
"itemSku": "CSMALBC2015",
"itemDescription": "Our premium signature product, made in small batches",
"minQty": 1,
"maxQty": 3,
"defaultQty": 1,
"sortOrder": 1,
"status": "active"
},
{
"itemId": "df0d13db-1332-4461-b3d1-b2774d47ff5f",
"itemName": "Classic Edition",
"itemSku": "CHARD2015",
"itemDescription": "A lighter everyday option from our classic range",
"minQty": 1,
"maxQty": 2,
"defaultQty": 1,
"sortOrder": 2,
"status": "active"
}
],
"attributes": [],
"options": [],
"relatedProducts": []
}{
"message": "string"
}Package
Get detailed information about a specific subscription package by its unique identifier (UUID) or slug.
curl --request GET \
--url https://api.marzipan.co/v1/subscription-packages/{packageId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.marzipan.co/v1/subscription-packages/{packageId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.marzipan.co/v1/subscription-packages/{packageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.marzipan.co/v1/subscription-packages/{packageId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.marzipan.co/v1/subscription-packages/{packageId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.marzipan.co/v1/subscription-packages/{packageId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.marzipan.co/v1/subscription-packages/{packageId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "084b80ef-d16d-4531-a25f-40b7ff4c744b",
"subscriptionType": "variable",
"name": "Discovery Plan",
"slug": "discovery-plan",
"sku": "DISCPLAN",
"url": "https://api.marzipan.co/subscription-packages/discovery-plan",
"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 Plan - Premium Subscription",
"metaDescription": "Join our Discovery Plan and get an exceptional selection delivered monthly to your door.",
"collections": [
{
"id": "46759fdd-1b5b-4339-a175-af0569c1ca73",
"name": "Subscriptions",
"slug": "subscriptions",
"description": "Subscription 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 Plan 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 Plan 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": "Signature Selection",
"itemSku": "CSMALBC2015",
"itemDescription": "Our premium signature product, made in small batches",
"minQty": 1,
"maxQty": 3,
"defaultQty": 1,
"sortOrder": 1,
"status": "active"
},
{
"itemId": "df0d13db-1332-4461-b3d1-b2774d47ff5f",
"itemName": "Classic Edition",
"itemSku": "CHARD2015",
"itemDescription": "A lighter everyday option from our classic range",
"minQty": 1,
"maxQty": 2,
"defaultQty": 1,
"sortOrder": 2,
"status": "active"
}
],
"attributes": [],
"options": [],
"relatedProducts": []
}{
"message": "string"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your API token.
Path Parameters
The unique identifier (UUID) or slug for the subscription package
Query Parameters
Include additional data. Available: subscribers
subscribers Response
Subscription package details
Unique identifier for the subscription package
Type of subscription package
picknmix, variable Package name
URL-friendly package identifier
Stock Keeping Unit
Full URL to the package page
Package status
active, inactive, out_of_stock Who can purchase this package
all, subscribers Always 'subscription' for packages
subscription Package description
SEO meta title
SEO meta description
Collections this package belongs to
Show child attributes
Show child attributes
Package images
Show child attributes
Show child attributes
Primary package image
Show child attributes
Show child attributes
Package price information
Show child attributes
Show child attributes
Sale price information if on sale
Show child attributes
Show child attributes
Default billing frequency in months
Available billing frequencies in months
How the subscription is priced
fixed, per_item Whether the subscription auto-renews
Minimum number of items required for pick & mix
Available items for pick & mix subscriptions. Only present for picknmix type
Show child attributes
Show child attributes
Package attributes
Package options
Related products
Number of subscribers. Only included when using ?include=subscribers parameter

