Subscriptions

Get Subscriptions

Retrieves a paginated list of product subscriptions.

get/v1/shops/{shopId}/subscriptions

Request body

status'pending' | 'trialing' | 'active' | 'past_due' | 'cancelled' | 'expired'
product_idinteger

Filter by product ID.

customer_idinteger

Filter by customer ID.

perPageinteger

Items per page, 1-100.

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "shop_id": 1,
      "customer_id": 1,
      "product_id": 1,
      "variant_id": 1,
      "product_name": "License Keys",
      "variant_name": "Standard",
      "initial_invoice_id": 1,
      "open_renewal_invoice_id": null,
      "gateway": null,
      "renewal_method": "manual",
      "payment_method_id": null,
      "status": "active",
      "interval": "month",
      "interval_count": 1,
      "trial_days": 0,
      "trial_ends_at": null,
      "quantity": 1,
      "currency": "USD",
      "recurring_price": "14.99",
      "recurring_price_usd": null,
      "renewal_delivery": "redeliver",
      "current_period_start": null,
      "current_period_end": null,
      "cycles_completed": 0,
      "cancel_at_period_end": false,
      "cancelled_at": null,
      "expired_at": null,
      "cancellation_reason": null,
      "external_id": null,
      "external_customer_id": null,
      "last_renewal_reminder_at": null,
      "failed_payment_count": 0,
      "suspended_at": null,
      "metadata": null,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "updated_at": "2026-08-28T18:23:02.000000Z",
      "deleted_at": null,
      "customer": {
        "id": 1,
        "email": "customer@sellauth.test"
      },
      "product": {
        "id": 1,
        "name": "License Keys",
        "stock_count": 0
      },
      "variant": {
        "id": 1,
        "name": "Standard"
      }
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/subscriptions?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/subscriptions?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/subscriptions?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/subscriptions",
  "per_page": 25,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.