GET
/
v2
/
subscriptions
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "sub_B6ClkdqNqVNBgY",
      "currency": "EUR",
      "status": "active",
      "purchase_order": "<string>",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "plan_id": "plan_zHmjoDee4ZRmQV",
      "invoicing_entity_id": "ive_jerrb484RHn",
      "checkout_session_id": "<string>",
      "crm_opportunity_id": "<string>",
      "minimum_invoice_fee": 250,
      "commitment_interval": {
        "period": "years",
        "count": 1
      },
      "renew_automatically": true,
      "renew_for": {
        "period": "years",
        "count": 1
      },
      "activation_strategy": "checkout",
      "starts_at": "2024-12-20T16:04:11Z",
      "contract_start": "2024-01-15T00:00:00Z",
      "contract_end": "2025-01-15T00:00:00Z",
      "initial_billing_at": "2024-12-20T16:04:11Z",
      "paused_at": "2024-12-20T16:04:11Z",
      "reactivate_at": "2024-12-20T16:04:11Z",
      "cancel_at": "2024-12-20T16:04:11Z",
      "cancellation_strategy": "refund_prorata",
      "cancellation_amount": 24000,
      "estimated_arr": 24000,
      "current_period_started_at": "2024-12-20T16:04:11Z",
      "current_period_ends_at": "2024-12-20T16:04:11Z",
      "next_payment_at": "2024-12-20T16:04:11Z",
      "next_payment_amount": 24000,
      "renews_at": "2024-12-20T16:04:11Z",
      "current_phase_id": "<string>",
      "properties": {},
      "custom_properties": {},
      "created_at": "2024-10-12T07:00:01.860Z",
      "updated_at": "2024-10-12T07:00:01.860Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
take
number | null
default:50
Required range: 0 <= x <= 100
​
skip
number | null
default:0
Required range: x >= 0
​
status
Available options:
all,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
​
status__in
Available options:
all,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
​
currency
string
​
currency__not
string
​
currency__isNull
string
​
currency__isNotNull
string
​
currency__equals
string
​
currency__contains
string
​
currency__startsWith
string
​
currency__endWith
string
​
plan_id
string
​
plan_id__not
string
​
plan_id__isNull
string
​
plan_id__isNotNull
string
​
plan_id__equals
string
​
plan_id__contains
string
​
plan_id__startsWith
string
​
plan_id__endWith
string
​
original_quote_id
string
​
original_quote_id__not
string
​
original_quote_id__isNull
string
​
original_quote_id__isNotNull
string
​
original_quote_id__equals
string
​
original_quote_id__contains
string
​
original_quote_id__startsWith
string
​
original_quote_id__endWith
string
​
customer_id
string
​
customer_id__not
string
​
customer_id__isNull
string
​
customer_id__isNotNull
string
​
customer_id__equals
string
​
customer_id__contains
string
​
customer_id__startsWith
string
​
customer_id__endWith
string
​
invoicing_entity_id
string
​
invoicing_entity_id__not
string
​
invoicing_entity_id__isNull
string
​
invoicing_entity_id__isNotNull
string
​
invoicing_entity_id__equals
string
​
invoicing_entity_id__contains
string
​
invoicing_entity_id__startsWith
string
​
invoicing_entity_id__endWith
string
​
customer_external_id
string
​
purchase_order
string
​
purchase_order__not
string
​
purchase_order__isNull
string
​
purchase_order__isNotNull
string
​
purchase_order__equals
string
​
purchase_order__contains
string
​
purchase_order__startsWith
string
​
purchase_order__endWith
string
​
updated_at
string
​
updated_at__not
string
​
updated_at__isNull
string
​
updated_at__isNotNull
string
​
updated_at__equals
string
​
updated_at__lt
string
​
updated_at__lte
string
​
updated_at__gt
string
​
updated_at__gte
string

Response

200 - application/json

The response is of type object.