Abandoned Checkouts6

Activity Logs1

Affiliate Payouts3

Affiliate Tiers6

Affiliates11

Analytics10

Anti-Fraud1

Blacklist8

Blog Posts8

Bundle Offers5

Categories6

Checkout1

Coupons7

Crypto Wallet6

Custom Fields4

Customers12

Disputes15

Domains4

Downloadable Files4

Email Marketing - Automations6

Email Marketing - Campaigns13

Email Marketing - Contacts2

Email Marketing - Lists10

Email Marketing - Stats2

Email Marketing - Templates8

Endpoints2

Feedbacks8

Groups5

Images5

Invoices22

Legal Pages3

Notifications8

Payment Methods8

Products39

Quantity Deals5

Reseller Connect2

Reseller Products2

Reseller Tiers6

Resellers15

Shipping Zones5

Shops6

Subscriptions6

Tickets10

User1

Webhook Logs1

Whitelist7

Subscriptions

Get Subscriptions

Changed on Nov 2, 2026

Retrieves a paginated list of product subscriptions.

get/v1/shops/{shopId}/subscriptions

Request

Base URL
https://api.sellauth.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sellauth/apis/sellauth-api/docs/v1/shops/:shopId/subscriptions/get.ts
A function with typed inputs. Its response is checked against the schema.

Request body

pageinteger nullable

Page number. Must be at least 1.

perPageinteger nullable

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'created_at' | 'current_period_end' | 'recurring_price_usd' | 'cycles_completed' nullable

orderDirection'asc' | 'desc' nullable

idinteger nullable

Filter by subscription ID.

Deprecated. Use statuses.

statusesstring[]

emailstring nullable

Filter by customer email.

customer_idinteger nullable

Filter by customer ID.

product_idinteger nullable

Filter by product ID.

variant_idinteger nullable

Filter by variant ID.

product_namestring nullable

Filter by product name.

variant_namestring nullable

Filter by variant name.

gatewaysobject nullable

Filter by payment gateways.

payment_method_idsobject nullable

Filter by payment method IDs.

intervalsstring[]

renewal_method'auto' | 'manual' nullable

Filter by automatic or manual renewal.

cancel_at_period_endboolean nullable

Only subscriptions set to end at the period end.

has_failed_paymentsboolean nullable

Only subscriptions with failed payments.

suspendedboolean nullable

Only suspended subscriptions.

currencystring nullable

Must be 3 characters.

external_idstring nullable

Filter by the gateway subscription ID.

created_at_startstring nullable

Must be a valid date.

created_at_endstring nullable

Must be a valid date. Must be a date after <code>created_at_start</code>.

current_period_end_startstring nullable

Must be a valid date.

current_period_end_endstring nullable

Must be a valid date. Must be a date after <code>current_period_end_start</code>.

cancelled_at_startstring nullable

Must be a valid date.

cancelled_at_endstring nullable

Must be a valid date. Must be a date after <code>cancelled_at_start</code>.

Example request

{
  "page": 1
}

Response

current_pageinteger

first_page_urlstring

frominteger

last_pageinteger

last_page_urlstring

next_page_urlstring nullable

pathstring

per_pageinteger

prev_page_urlstring nullable

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-11-01T20:00:51.000000Z",
      "updated_at": "2026-11-01T20:00:51.000000Z",
      "deleted_at": null,
      "customer": {
        "id": 1,
        "email": "customer@sellauth.test"
      },
      "product": {
        "id": 1,
        "name": "License Keys"
      },
      "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": "&laquo; Previous",
      "page": null,
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/subscriptions?page=1",
      "label": "1",
      "page": 1,
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "page": null,
      "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

Nov 2, 2026ff0d59c98d7a Revision changes
- breaking
  request property / was restricted to a list of enum values
- breaking
  request property / was restricted to a list of enum values
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  added the new active enum value to the request property /
- info
  added the new cancelled enum value to the request property /
- info
  added the new day enum value to the request property /
- info
  added the new expired enum value to the request property /
- info
  added the new month enum value to the request property /
- info
  added the new past_due enum value to the request property /
- info
  added the new pending enum value to the request property /
- info
  added the new trialing enum value to the request property /
- info
  added the new week enum value to the request property /
- info
  added the new year enum value to the request property /
- info
  added the optional property // to the response with the status
Oct 20, 2026000b5ef816e6 Revision changes
- warning
  removed the optional property /// from the response with the status

Operation history (3 revisions)

Get Subscriptions

Request

Request body

Example request

Response 200OK

Example response

Changes

Response