List subscriptions
Returns a list of subscriptions.
curl --request GET \
--url https://api.juo.io/admin/v1/subscriptions \
--header 'X-Juo-Admin-Api-Key: <api-key>'{
"resource": "list",
"hasNextPage": true,
"hasPrevPage": true,
"endCursor": null,
"startCursor": null,
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription",
"serial": "<string>",
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"canceledAt": null,
"customer": "<string>",
"nextBillingDate": null,
"currentCycle": 1,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription-item",
"title": "<string>",
"subtitle": null,
"quantity": 2,
"totalPrice": 1,
"variant": "<string>",
"recurringCycleLimit": null
}
],
"discounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription-discount",
"title": null,
"target": {
"type": "shipping"
},
"value": {
"amount": 123,
"type": "fixed-amount",
"appliesOnEachItem": true
},
"recurringCycleLimit": null
}
],
"paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currencyCode": "<string>",
"deliveryAddress": null,
"deliveryMethod": null,
"deliveryPrice": 1
}
]
}Authorizations
Query Parameters
The search query string. See search query language for information how to build the search query. Supported fields are listed here.
See pagination for more details on how to paginate the results.
1 <= x <= 100See pagination for more details on how to paginate the results.
1See pagination for more details on how to paginate the results.
1customer Response
list subscription Unique serial number that increments sequentially with each new subscription within a store.
1active, paused, canceled, failed, expired Purchase date of the subscription.
Last update date of the subscription.
Cancellation date of the subscription.
This field is expandable.
1The 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.
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.
x >= 0subscription-item 1Matches the variant title in most cases
1x >= 1Final item price including all discounts and taxes
x >= 0This field is expandable.
1The 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.
x >= 1subscription-discount The title of the discount shown to customers, typically displayed as a discount code.
1shipping 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.
x >= 1This field is expandable.
The currency that applies to both item prices and delivery price.
3Customer's first name.
1Customer's last name.
1Primary street address.
1Additional address information (apartment, suite, etc.)
1Postal/ZIP code.
1City name.
1Full country name.
1Two-letter country code (ISO 3166-1).
2Province/state code.
1Full province/state name.
1Contact phone number.
1Company name.
1The delivery price for the upcoming renewal.
x >= 0curl --request GET \
--url https://api.juo.io/admin/v1/subscriptions \
--header 'X-Juo-Admin-Api-Key: <api-key>'{
"resource": "list",
"hasNextPage": true,
"hasPrevPage": true,
"endCursor": null,
"startCursor": null,
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription",
"serial": "<string>",
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"canceledAt": null,
"customer": "<string>",
"nextBillingDate": null,
"currentCycle": 1,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription-item",
"title": "<string>",
"subtitle": null,
"quantity": 2,
"totalPrice": 1,
"variant": "<string>",
"recurringCycleLimit": null
}
],
"discounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": "subscription-discount",
"title": null,
"target": {
"type": "shipping"
},
"value": {
"amount": 123,
"type": "fixed-amount",
"appliesOnEachItem": true
},
"recurringCycleLimit": null
}
],
"paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currencyCode": "<string>",
"deliveryAddress": null,
"deliveryMethod": null,
"deliveryPrice": 1
}
]
}