Skip to main content
GET
/
subscriptions
cURL
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": "<string>",
  "startCursor": "<string>",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription",
      "serial": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "nextBillingDate": "2023-11-07T05:31:56Z",
      "currentCycle": 1,
      "currencyCode": "<string>",
      "billingPolicy": {
        "intervalCount": 2
      },
      "deliveryPolicy": {
        "intervalCount": 2
      },
      "deliveryMethod": {
        "title": "<string>",
        "description": "<string>"
      },
      "customer": "<string>",
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "resource": "subscription-item",
          "title": "<string>",
          "subtitle": "<string>",
          "quantity": 2,
          "totalPrice": 1,
          "recurringCycleLimit": 2,
          "canceledAt": "2023-11-07T05:31:56Z",
          "billingPolicy": {
            "interval": "DAY",
            "intervalCount": 183,
            "anchors": [
              {
                "type": "WEEKDAY",
                "day": 16,
                "month": 6,
                "cutoffDay": 16
              }
            ],
            "minCycles": 2,
            "maxCycles": 2
          },
          "deliveryPolicy": {
            "interval": "DAY",
            "intervalCount": 183,
            "anchors": [
              {
                "type": "WEEKDAY",
                "day": 16,
                "month": 6,
                "cutoffDay": 16
              }
            ]
          },
          "variant": "<string>",
          "product": "<string>"
        }
      ],
      "discounts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "resource": "subscription-discount",
          "title": "<string>",
          "target": {
            "type": "shipping"
          },
          "value": {
            "amount": 123,
            "type": "fixed-amount",
            "appliesOnEachItem": true
          },
          "recurringCycleLimit": 2
        }
      ],
      "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deliveryAddress": {
        "firstName": "<string>",
        "lastName": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "zip": "<string>",
        "city": "<string>",
        "country": "<string>",
        "countryCode": "<string>",
        "provinceCode": "<string>",
        "province": "<string>",
        "phone": "<string>",
        "company": "<string>"
      },
      "deliveryPrice": 1
    }
  ]
}

Authorizations

​
X-Juo-Admin-Api-Key
string
header
required

Headers

​
X-Tenant-ID
string

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>[]

Specify which related resources to include in the response. Currently supports 'customer'.

Available options:
customer
​
includeCanceledItems
boolean
default:false

Whether to include canceled subscriptions in the results.

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