Skip to main content
GET
/
api
/
v1
/
subscriptions
List subscriptions
curl --request GET \
  --url http://localhost:7701/api/v1/subscriptions \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "plan": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Basic Monthly",
        "description": "<string>",
        "amount": 2990,
        "currency": "BRL",
        "interval": "monthly",
        "interval_count": 1,
        "trial_period_days": 7,
        "billing_day": 5,
        "is_active": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "customer": {},
      "card": {
        "last_4_digits": "4242",
        "brand": "visa",
        "expire_month": "12",
        "expire_year": "2028"
      },
      "coupon": {},
      "amount": 2990,
      "original_amount": 2990,
      "discount_amount": 500,
      "currency": "BRL",
      "interval": "monthly",
      "interval_count": 1,
      "billing_day": 5,
      "trial": {
        "period_days": 7,
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "current_period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "next_billing_at": "2023-11-07T05:31:56Z",
      "paused_at": "2023-11-07T05:31:56Z",
      "paused_until": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "cancel_at": "2023-11-07T05:31:56Z",
      "cancel_at_period_end": false,
      "plan_change_at": "2023-11-07T05:31:56Z",
      "new_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": [
        {}
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42,
    "last_page": 3
  }
}

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Query Parameters

per_page
integer
Example:

15

page
integer
Example:

1

Response

Paginated list of subscriptions

data
object[]
meta
object