API documentation
Integrations
Analytics
Bank Accounts
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- GETGet subscription transitions
- GETGet subscription transition
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- POSTCreate subscription transition
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTCancel subscription transition
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTRenew subscription
- POSTSimulate subscription updates
- POSTTransition subscription to next phase
Subscriptions > Templates
Third-party apps
Wallets
curl --request GET \
--url https://api.hyperline.co/v2/subscriptions/transitions \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "<string>",
"customer_id": "<string>",
"base_subscription_id": "<string>",
"source_subscription_id": "<string>",
"target_subscription_id": "<string>",
"status": "scheduled",
"transitioned_at": "2023-12-25",
"name": "<string>",
"transition_date": "2023-12-25",
"application_schedule": "immediately",
"billing_cycle_transition_method": "keep_current_billing_cycle",
"calculation_method": "do_not_charge"
}
]
}Get subscription transitions
Retrieve existing subscription transitions.
curl --request GET \
--url https://api.hyperline.co/v2/subscriptions/transitions \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0,
"approximateCount": false
},
"data": [
{
"id": "<string>",
"customer_id": "<string>",
"base_subscription_id": "<string>",
"source_subscription_id": "<string>",
"target_subscription_id": "<string>",
"status": "scheduled",
"transitioned_at": "2023-12-25",
"name": "<string>",
"transition_date": "2023-12-25",
"application_schedule": "immediately",
"billing_cycle_transition_method": "keep_current_billing_cycle",
"calculation_method": "do_not_charge"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
0 <= x <= 100x >= 0Response
List of SubscriptionTransition.
Show child attributes
Show child attributes
The unique identifier of the subscription transition
The ID of the customer associated with the transition
The ID of the original subscription from which this transition is derived. It references the last active version of the subscription.
The ID of the subscription to transition from
The ID of the subscription to transition to
The current status of the subscription transition. Possible values are 'scheduled', 'completed', 'failed', and 'draft'.
scheduled, completed, failed, draft An optional name for the transition
Whether the transition should be applied 'immediately' or 'scheduled' for a future date.
immediately, scheduled The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.
keep_current_billing_cycle, align_to_new_billing_cycle The calculation method to use for the transition. 'do_not_charge' will not generate any transition invoice. 'pro_rata' will generate a prorated invoice for the remaining period.
do_not_charge, pro_rata Was this page helpful?