Skip to main content
GET
/
v2
/
subscriptions
/
transitions
List subscription transitions
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions/transitions \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "base_subscription_id": "<string>",
      "source_subscription_id": "<string>",
      "target_subscription_id": "<string>",
      "transitioned_at": "2023-12-25",
      "name": "<string>",
      "transition_date": "2023-12-25"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

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:
scheduled,
draft,
completed,
cancelled,
failed,
pending_quote_signature
​
status__in
Available options:
scheduled,
draft,
completed,
cancelled,
failed,
pending_quote_signature
​
source_subscription_id
string
​
source_subscription_id__not
string
​
source_subscription_id__isNull
string
​
source_subscription_id__isNotNull
string
​
source_subscription_id__equals
string
​
source_subscription_id__contains
string
​
source_subscription_id__startsWith
string
​
source_subscription_id__endWith
string
​
base_subscription_id
string
​
base_subscription_id__not
string
​
base_subscription_id__isNull
string
​
base_subscription_id__isNotNull
string
​
base_subscription_id__equals
string
​
base_subscription_id__contains
string
​
base_subscription_id__startsWith
string
​
base_subscription_id__endWith
string
​
target_subscription_id
string
​
target_subscription_id__not
string
​
target_subscription_id__isNull
string
​
target_subscription_id__isNotNull
string
​
target_subscription_id__equals
string
​
target_subscription_id__contains
string
​
target_subscription_id__startsWith
string
​
target_subscription_id__endWith
string
​
transition_date
string<date-time>
​
transition_date__not
string<date-time>
​
transition_date__isNull
string<date-time>
​
transition_date__isNotNull
string<date-time>
​
transition_date__equals
string<date-time>
​
transition_date__lt
string<date-time>
​
transition_date__lte
string<date-time>
​
transition_date__gt
string<date-time>
​
transition_date__gte
string<date-time>
​
transitioned_at
string<date-time>
​
transitioned_at__not
string<date-time>
​
transitioned_at__isNull
string<date-time>
​
transitioned_at__isNotNull
string<date-time>
​
transitioned_at__equals
string<date-time>
​
transitioned_at__lt
string<date-time>
​
transitioned_at__lte
string<date-time>
​
transitioned_at__gt
string<date-time>
​
transitioned_at__gte
string<date-time>

Response

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

List of SubscriptionTransition.