GET
/
v2
/
subscriptions
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 123
  },
  "data": [
    {
      "id": "sub_B6ClkdqNqVNBgY",
      "cancel_at": "2023-01-20T16:04:11Z",
      "created_at": "2023-01-20T16:04:11Z",
      "current_period_ends_at": "2023-01-20T16:04:11Z",
      "current_period_started_at": "2023-01-20T16:04:11Z",
      "next_payment_at": "2023-01-20T16:04:11Z",
      "paused_at": "2023-01-20T16:04:11Z",
      "renews_at": "2023-01-20T16:04:11Z",
      "starts_at": "2023-01-20T16:04:11Z",
      "trial_ends_at": "2023-01-20T16:04:11Z",
      "purchase_order": "<string>",
      "updated_at": "2023-01-20T16:04:11Z",
      "billing_plan_id": "<string>",
      "billing_scenario_id": "<string>",
      "checkout_session_id": "<string>",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "last_invoice_id": "<string>",
      "currency": "EUR",
      "interval": "weekly",
      "invoice_schedule": "period_start",
      "start_automatically": true,
      "status": "active",
      "properties": {},
      "plan_id": "plan_zHmjoDee4ZRmQV",
      "invoicing_entity_id": "ive_jerrb484RHn",
      "commitment_interval": {
        "period": "years",
        "count": 1
      },
      "renew_automatically": true,
      "activation_strategy": "checkout",
      "reactivate_at": "2023-01-20T16:04:11Z",
      "cancellation_strategy": "refund_prorata",
      "cancellation_amount": 123,
      "estimated_arr": 123
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Query Parameters

take
number | null
default: 50
skip
number | null
default: 0

Response

200 - application/json
meta
object
required
data
object[]
required

List of Subscription.