Skip to main content
GET
Get a subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is the account token returned from the Login endpoint.

Path Parameters

subscriptionId
string<uuid>
required

Subscription ID

Response

Success

Full detail of a customer subscription.

id
string<uuid>

Subscription ID

subscriptionType
enum<string>

Type of subscription

Available options:
variable,
picknmix
email
string

Customer email address

name
string

Subscription / product name

quantity
integer

Subscription quantity

status
string

Subscription status

createdAt
string

Creation date (DD/MM/YYYY) or relative time if today

options
object

Subscription options

availableItems
object[]

Available pick & mix items. Only present for picknmix subscriptions

pickAndMixItems
object[]

Currently selected pick & mix items. Only present for picknmix subscriptions

batchedShipments
boolean

Whether shipments are batched

upcomingShipments
object[]

Upcoming (non-skipped) scheduled shipments

currentPeriodStart
string

Current billing period start (DD/MM/YYYY)

currentPeriodEnd
string

Current billing period end (DD/MM/YYYY)

expiresAt
string

Subscription end date (DD/MM/YYYY)

billingInterval
integer

Billing interval in months

billingIntervalFriendly
string

Human-friendly billing interval

nextBillingDate
string | null

Next billing date (DD/MM/YYYY)

upcomingAdditionalItems
object[] | null

Additional one-off items on the next shipment

hasProcessingShipment
boolean

Whether a shipment is currently being processed

failedRenewal
object | null

Present only when an active subscription's last renewal failed

price
object
preferredDeliveryOption
enum<string> | null

Preferred shipping option

Available options:
pickup,
delivery
preferredDeliveryAddress
object | null

Preferred delivery address

preferredPickupLocation
object | null

Preferred pickup location

defaultPaymentMethod
object | null

Default payment method for the subscription

paymentProvider
string

Payment provider for the default payment method

paymentProviders
object

Configuration for each payment provider enabled on the tenant (stripe, paypal, payfast)