API documentation
Integrations
Analytics
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
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Subscriptions
Get subscription
Retrieve the details of an existing subscription.
GET
/
v2
/
subscriptions
/
{id}
curl --request GET \
--url https://api.hyperline.co/v2/subscriptions/{id} \
--header 'Authorization: Bearer <token>'
{
"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",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"attached_at": "2024-01-15T00:00:00Z",
"detached_at": "2024-04-15T00:00:00Z",
"current_period_started_at": "2024-01-15T00:00:00Z",
"current_period_ends_at": "2024-02-15T00:00:00Z",
"next_payment_at": "2024-02-15T00:00:00Z",
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
],
"coupons": [
{
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": "<string>",
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"apply_at": "2024-10-13T02:00:00.000Z",
"expires_at": "2024-10-13T02:00:00.000Z"
}
],
"phases": [
{
"id": "sup_1FoLfIQ5VOMbXf",
"type": "standard",
"status": "active",
"order": 0,
"activation_strategy": "manual",
"end_strategy": "duration",
"duration": {
"count": 1,
"period": "years"
},
"billing_date_setting": "phase_start",
"initial_billing_at": "2024-10-13T02:00:00.000Z",
"starts_at": "2024-10-13T02:00:00.000Z",
"ends_at": "2024-10-13T02:00:00.000Z",
"billing_cycle_alignment": "anniversary",
"transition_calculation_method": "prorata",
"transition_invoicing_schedule": "immediately",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"attached_at": "2024-01-15T00:00:00Z",
"detached_at": "2024-04-15T00:00:00Z",
"current_period_started_at": "2024-01-15T00:00:00Z",
"current_period_ends_at": "2024-02-15T00:00:00Z",
"next_payment_at": "2024-02-15T00:00:00Z",
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
],
"coupons": [
{
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": "<string>",
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"apply_at": "2024-10-13T02:00:00.000Z",
"expires_at": "2024-10-13T02:00:00.000Z"
}
],
"created_at": "2024-10-12T07:00:01.860Z",
"updated_at": "2024-10-12T07:00:01.860Z"
}
],
"quote": {
"id": "quo_38YwqvItBH3d8a",
"status": "signed"
},
"plan": {
"id": "plan_zHmjoDee4ZRmQV",
"name": "My example plan"
},
"checkout_session": {
"id": "che_hEUPdVG7IgjpW1",
"status": "opened",
"available_payment_methods": [
"card"
],
"redirect_url": "https://app.hyperline.co/callback/checkout",
"send_to": {
"email": "josh@alpeak.com",
"message": "<string>"
},
"url": "https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1"
},
"payment_method_type": "card",
"payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2026-11",
"brand": "visa"
},
"generate_draft_invoices": true,
"contract_terms": {
"status": "active",
"activation_strategy": "start_date",
"end_strategy": "duration",
"starts_at": "2024-12-31T23:00:00.000Z",
"ends_at": "2025-06-30T21:59:59.999Z",
"duration": {
"count": 6,
"period": "months"
},
"renew_automatically": true,
"renew_for_duration": {
"count": 1,
"period": "years"
},
"current_period_started_at": "2025-06-30T22:00:00.000Z",
"current_period_ends_at": "2026-06-30T21:59:59.999Z"
},
"live_billing": {
"total_amount": 123,
"total_discount": 123,
"fixed_amount": 123,
"billing_items": [
{
"id": "<string>",
"total_amount": 123,
"original_amount": 123,
"discount_amount": 123,
"item_name": "<string>",
"tiers": [
{
"from": 123,
"to": 123,
"amount": 123,
"total_amount": 123,
"count": 123
}
]
}
],
"coupons": [
{
"id": "<string>",
"name": "<string>",
"discount_amount": 123,
"item_ids": [
"<string>"
]
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Response
200
application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v2/subscriptions/{id} \
--header 'Authorization: Bearer <token>'
{
"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",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"attached_at": "2024-01-15T00:00:00Z",
"detached_at": "2024-04-15T00:00:00Z",
"current_period_started_at": "2024-01-15T00:00:00Z",
"current_period_ends_at": "2024-02-15T00:00:00Z",
"next_payment_at": "2024-02-15T00:00:00Z",
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
],
"coupons": [
{
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": "<string>",
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"apply_at": "2024-10-13T02:00:00.000Z",
"expires_at": "2024-10-13T02:00:00.000Z"
}
],
"phases": [
{
"id": "sup_1FoLfIQ5VOMbXf",
"type": "standard",
"status": "active",
"order": 0,
"activation_strategy": "manual",
"end_strategy": "duration",
"duration": {
"count": 1,
"period": "years"
},
"billing_date_setting": "phase_start",
"initial_billing_at": "2024-10-13T02:00:00.000Z",
"starts_at": "2024-10-13T02:00:00.000Z",
"ends_at": "2024-10-13T02:00:00.000Z",
"billing_cycle_alignment": "anniversary",
"transition_calculation_method": "prorata",
"transition_invoicing_schedule": "immediately",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": true,
"attached_at": "2024-01-15T00:00:00Z",
"detached_at": "2024-04-15T00:00:00Z",
"current_period_started_at": "2024-01-15T00:00:00Z",
"current_period_ends_at": "2024-02-15T00:00:00Z",
"next_payment_at": "2024-02-15T00:00:00Z",
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"id": "<string>",
"amount": 24000
}
]
}
],
"coupons": [
{
"description": "<string>",
"expiration_date": "2024-10-13T02:00:00.000Z",
"redemption_limit": 123,
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": "<string>",
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"apply_at": "2024-10-13T02:00:00.000Z",
"expires_at": "2024-10-13T02:00:00.000Z"
}
],
"created_at": "2024-10-12T07:00:01.860Z",
"updated_at": "2024-10-12T07:00:01.860Z"
}
],
"quote": {
"id": "quo_38YwqvItBH3d8a",
"status": "signed"
},
"plan": {
"id": "plan_zHmjoDee4ZRmQV",
"name": "My example plan"
},
"checkout_session": {
"id": "che_hEUPdVG7IgjpW1",
"status": "opened",
"available_payment_methods": [
"card"
],
"redirect_url": "https://app.hyperline.co/callback/checkout",
"send_to": {
"email": "josh@alpeak.com",
"message": "<string>"
},
"url": "https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1"
},
"payment_method_type": "card",
"payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2026-11",
"brand": "visa"
},
"generate_draft_invoices": true,
"contract_terms": {
"status": "active",
"activation_strategy": "start_date",
"end_strategy": "duration",
"starts_at": "2024-12-31T23:00:00.000Z",
"ends_at": "2025-06-30T21:59:59.999Z",
"duration": {
"count": 6,
"period": "months"
},
"renew_automatically": true,
"renew_for_duration": {
"count": 1,
"period": "years"
},
"current_period_started_at": "2025-06-30T22:00:00.000Z",
"current_period_ends_at": "2026-06-30T21:59:59.999Z"
},
"live_billing": {
"total_amount": 123,
"total_discount": 123,
"fixed_amount": 123,
"billing_items": [
{
"id": "<string>",
"total_amount": 123,
"original_amount": 123,
"discount_amount": 123,
"item_name": "<string>",
"tiers": [
{
"from": 123,
"to": 123,
"amount": 123,
"total_amount": 123,
"count": 123
}
]
}
],
"coupons": [
{
"id": "<string>",
"name": "<string>",
"discount_amount": 123,
"item_ids": [
"<string>"
]
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.