List subscriptions - Developer documentation

Authorizations

X-Juo-Admin-Api-Key

string

header

required

Headers

X-Tenant-ID

string

required

Unique identifier of the tenant in the system (usually a store identifier)

Query Parameters

query

string

The search query string. See search query language for information how to build the search query. Supported fields are listed here.

limit

integer

default:20

See pagination for more details on how to paginate the results.

Required range: 1 <= x <= 100

after

string

See pagination for more details on how to paginate the results.

Minimum string length: 1

before

string

See pagination for more details on how to paginate the results.

Minimum string length: 1

sort

string

default:createdAt:asc

See sorting for more details on how to sort the results.

expand

enum<string>[]

Available options:

customer

includeCanceledItems

boolean

default:false

Response

200 - application/json

Default Response

resource

enum<string>

required

Available options:

list

hasNextPage

boolean

required

hasPrevPage

boolean

required

endCursor

null | string

required

startCursor

null | string

required

data

Subscription · object[]

required

Show child attributes

data.id

string<uuid>

required

data.resource

enum<string>

required

Available options:

subscription

data.serial

string

required

Unique serial number that increments sequentially with each new subscription within a store.

Minimum string length: 1

data.status

enum<string>

required

Available options:

active,

paused,

canceled,

failed,

expired,

merged

data.createdAt

string<date-time>

required

Purchase date of the subscription.

data.updatedAt

string<date-time>

required

Last update date of the subscription.

data.canceledAt

null | string<date-time>

required

Cancellation date of the subscription.

data.customer

required

This field is expandable.

Minimum string length: 1

data.nextBillingDate

null | string<date-time>

required

The next billing date determines when the renewal process begins its billing phase. When billing succeeds, it creates one order—or multiple orders for prepaid subscriptions.

data.currentCycle

integer

required

The subscription's billing cycle count. It starts at 0 (before the first billing is completed), changes to 1 (after one billing is completed), and increases by 1 with each subsequent billing.

Required range: x >= 0

data.items

SubscriptionItem · object[]

required

Minimum array length: 1

Show child attributes

data.items.id

string<uuid>

required

data.items.resource

enum<string>

required

Available options:

subscription-item

data.items.title

string

required

Minimum string length: 1

data.items.subtitle

null | string

required

Matches the variant title in most cases

Minimum string length: 1

data.items.quantity

integer

required

Required range: x >= 1

data.items.totalPrice

number

required

Final item price including all discounts and taxes

Required range: x >= 0

data.items.variant

required

This field is expandable.

Minimum string length: 1

data.items.recurringCycleLimit

null | integer

required

The number of billing cycles for which this item will be applied. After the recurring cycle limit is met the item will be removed from the subscription.

Required range: x >= 1

data.items.canceledAt

null | string<date-time>

required

Cancellation date of the item.

data.discounts

SubscriptionDiscount · object[]

required

Show child attributes

data.discounts.id

string<uuid>

required

data.discounts.resource

enum<string>

required

Available options:

subscription-discount

data.discounts.title

null | string

required

The title of the discount shown to customers, typically displayed as a discount code.

Minimum string length: 1

data.discounts.target

object

required

Option 1
Option 2

Show child attributes

data.discounts.target.type

enum<string>

required

Available options:

shipping

data.discounts.value

object

required

Option 1
Option 2

Show child attributes

data.discounts.value.amount

number

required

data.discounts.value.type

enum<string>

required

Available options:

fixed-amount

data.discounts.value.appliesOnEachItem

boolean

required

When true, the amount will be proportionally split among all the items.

data.discounts.recurringCycleLimit

null | integer

required

The number of billing cycles for which this discount will be applied. After the recurring cycle limit is met the discount will be removed from the subscription.

Required range: x >= 1

data.paymentMethod

required

This field is expandable.

data.currencyCode

string

required

The currency that applies to both item prices and delivery price.

Required string length: 3

data.deliveryAddress

object

required

Show child attributes

data.deliveryAddress.firstName

null | string

required

Customer's first name.

Minimum string length: 1

data.deliveryAddress.lastName

null | string

required

Customer's last name.

Minimum string length: 1

data.deliveryAddress.address1

null | string

required

Primary street address.

Minimum string length: 1

data.deliveryAddress.address2

null | string

required

Additional address information (apartment, suite, etc.)

Minimum string length: 1

data.deliveryAddress.zip

null | string

required

Postal/ZIP code.

Minimum string length: 1

data.deliveryAddress.city

null | string

required

City name.

Minimum string length: 1

data.deliveryAddress.country

null | string

required

Full country name.

Minimum string length: 1

data.deliveryAddress.countryCode

null | string

required

Two-letter country code (ISO 3166-1).

Required string length: 2

data.deliveryAddress.provinceCode

null | string

required

Province/state code.

Minimum string length: 1

data.deliveryAddress.province

null | string

required

Full province/state name.

Minimum string length: 1

data.deliveryAddress.phone

null | string

required

Contact phone number.

Minimum string length: 1

data.deliveryAddress.company

null | string

required

Company name.

Minimum string length: 1

data.deliveryMethod

object

required

Show child attributes

data.deliveryMethod.type

enum<string>

required

Available options:

shipping,

local-delivery,

pickup

data.deliveryMethod.title

null | string

required

data.deliveryMethod.description

null | string

required

data.deliveryPrice

number

required

The delivery price for the upcoming renewal.

Required range: x >= 0

Core Resources

Authorizations

Headers

Query Parameters

Response