Skip to main content
GET
/
v3
/
stores
/
{store_id}
/
customers
/
me
/
subscriptions
List authenticated customer subscriptions
curl --request GET \
  --url https://api.myscalev.com/v3/stores/{store_id}/customers/me/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "activated_at": "2023-11-07T05:31:56Z",
      "business_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canceled_at": "2023-11-07T05:31:56Z",
      "current_period_end": "2023-11-07T05:31:56Z",
      "current_period_start": "2023-11-07T05:31:56Z",
      "customer": {
        "confirmed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "id": 123,
        "last_updated_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "status": "<string>"
      },
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expired_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inserted_at": "2023-11-07T05:31:56Z",
      "interval": "day",
      "interval_count": 123,
      "is_active": true,
      "is_cancel_at_period_end": true,
      "status": "unactivated",
      "store": {
        "id": 123,
        "logo": "<string>",
        "name": "<string>",
        "unique_id": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "<string>",
      "subscription_items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "status": "unactivated",
          "unit_price": 123,
          "variant": {
            "id": 123,
            "item_type": "physical",
            "name": "<string>",
            "product_name": "<string>"
          }
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "is_paginated": true,
  "has_next": false,
  "last_id": "123e4567-e89b-12d3-a456-426614174000",
  "page_size": 25
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
store_id
string
required

Store unique_id.

Query Parameters

​
page_size
integer

Number of items per page (default: 25, max: 25)

Required range: x <= 25
Example:

25

​
last_id
string<uuid>

Last subscription UUID for cursor-based pagination

​
status
enum<string>

Filter by subscription status (unactivated, active, canceled, expired)

Available options:
unactivated,
active,
canceled,
expired,
failed

Response

Subscriptions list

Paginated list payload for v3.

​
data
Subscription · object[]
required
​
is_paginated
enum<boolean>
required
Available options:
true
Example:

true

​
has_next
boolean
default:false
Example:

false

​
last_id
string<uuid> | null
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
page_size
integer
default:25
Example:

25