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>' \
  --header 'X-Tenant-ID: <x-tenant-id>'
{
  "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,
          "canceledAt": 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

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

Headers

​
X-Tenant-ID
string
required

Query Parameters

​
query
string
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
after
string
Minimum length: 1
​
before
string
Minimum length: 1
​
sort
string
default:createdAt:asc
​
expand
enum<string>[]
​
includeCanceledItems
boolean
default:false

Response

200 - application/json
​
resource
enum<string>
required
Available options:
list
​
hasNextPage
boolean
required
​
hasPrevPage
boolean
required
​
endCursor
string | null
required
​
startCursor
string | null
required
​
data
Subscription · object[]
required