Get a subscription
Retrieve full detail for one of the authenticated customer’s subscriptions, including pick & mix items, upcoming shipments, additional items, billing period, preferred shipping options, payment method and any failed-renewal information.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is the account token returned from the Login endpoint.
Path Parameters
Subscription ID
Response
Success
Full detail of a customer subscription.
Subscription ID
Type of subscription
variable, picknmix Customer email address
Subscription / product name
Subscription quantity
Subscription status
Creation date (DD/MM/YYYY) or relative time if today
Subscription options
Available pick & mix items. Only present for picknmix subscriptions
Currently selected pick & mix items. Only present for picknmix subscriptions
Whether shipments are batched
Upcoming (non-skipped) scheduled shipments
Current billing period start (DD/MM/YYYY)
Current billing period end (DD/MM/YYYY)
Subscription end date (DD/MM/YYYY)
Billing interval in months
Human-friendly billing interval
Next billing date (DD/MM/YYYY)
Additional one-off items on the next shipment
Whether a shipment is currently being processed
Present only when an active subscription's last renewal failed
Preferred shipping option
pickup, delivery Preferred delivery address
Preferred pickup location
Default payment method for the subscription
Payment provider for the default payment method
Configuration for each payment provider enabled on the tenant (stripe, paypal, payfast)

