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
Package images
Primary package image
Package price information
Sale price information if on sale
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
Package attributes
Package options
Related products
Number of subscribers. Only included when using ?include=subscribers parameter