Get subscription configuration options
curl --request GET \
--url https://api.marzipan.co/v1/subscription-packages/{productId}/configuration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.marzipan.co/v1/subscription-packages/{productId}/configuration"
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/{productId}/configuration', 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/{productId}/configuration",
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/{productId}/configuration"
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/{productId}/configuration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.marzipan.co/v1/subscription-packages/{productId}/configuration")
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{
"data": {
"subscriptionType": "picknmix",
"pricingType": "calculated",
"fixedPrice": null,
"frequencies": [
1,
3,
6
],
"defaultFrequency": 1,
"availableItems": [
{
"id": "9b2f1c4e-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"name": "House Blend 250g",
"sku": "COF-HB-250",
"image": null,
"price": 8.5,
"salePrice": null,
"subscriberPrice": 7.5,
"description": "Our signature house blend.",
"status": "active",
"minQuantity": 1,
"maxQuantity": 5,
"defaultQuantity": 1
}
],
"minItems": 3
}
}{
"message": "Product is not a subscription"
}Subscriptions
Get subscription configuration options
Returns the options for configuring a subscription package: its subscription and pricing types, billing frequencies, and — for pick & mix subscriptions — the list of available items with their quantity constraints and pricing. Responses are cached (fresh for 5 minutes, served stale for up to 30 minutes).
GET
/
subscription-packages
/
{productId}
/
configuration
Get subscription configuration options
curl --request GET \
--url https://api.marzipan.co/v1/subscription-packages/{productId}/configuration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.marzipan.co/v1/subscription-packages/{productId}/configuration"
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/{productId}/configuration', 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/{productId}/configuration",
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/{productId}/configuration"
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/{productId}/configuration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.marzipan.co/v1/subscription-packages/{productId}/configuration")
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{
"data": {
"subscriptionType": "picknmix",
"pricingType": "calculated",
"fixedPrice": null,
"frequencies": [
1,
3,
6
],
"defaultFrequency": 1,
"availableItems": [
{
"id": "9b2f1c4e-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"name": "House Blend 250g",
"sku": "COF-HB-250",
"image": null,
"price": 8.5,
"salePrice": null,
"subscriberPrice": 7.5,
"description": "Our signature house blend.",
"status": "active",
"minQuantity": 1,
"maxQuantity": 5,
"defaultQuantity": 1
}
],
"minItems": 3
}
}{
"message": "Product is not a subscription"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your API token.
Path Parameters
The id of the subscription product.
Response
The subscription configuration.
Configuration options for a subscription package.
Show child attributes
Show child attributes
⌘I

