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",
"name": "Yearly subscription",
"currency": "EUR",
"status": "active",
"purchase_order": "<string>",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_jerrb484RHn",
"plan_id": "plan_zHmjoDee4ZRmQV",
"template_id": "subt_7gdusOkqr5L0B8",
"checkout_session_id": "<string>",
"crm_opportunity_id": null,
"minimum_invoice_fee": 250,
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"activation_strategy": "start_date",
"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": 123,
"cancellation_reason": "<string>",
"estimated_arr": 123,
"contract_value": 123,
"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": 123,
"renews_at": "2024-12-20T16:04:11Z",
"current_phase_id": "<string>",
"display_shipping_details": true,
"properties": null,
"custom_properties": {},
"invoice_schedule": "period_start",
"generate_document": true,
"document_name": "<string>",
"add_tax_to_document": true,
"generate_draft_invoices": true,
"invoice_custom_note": "<string>",
"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": "once"
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"amount": 123,
"id": "<string>"
}
]
}
],
"coupons": [
{
"description": null,
"expiration_date": null,
"redemption_limit": null,
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": null,
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"duration_period": "days",
"duration_count": 123,
"apply_at": null,
"expires_at": null
}
]
}
]
}Retrieve existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.
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",
"name": "Yearly subscription",
"currency": "EUR",
"status": "active",
"purchase_order": "<string>",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_jerrb484RHn",
"plan_id": "plan_zHmjoDee4ZRmQV",
"template_id": "subt_7gdusOkqr5L0B8",
"checkout_session_id": "<string>",
"crm_opportunity_id": null,
"minimum_invoice_fee": 250,
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"activation_strategy": "start_date",
"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": 123,
"cancellation_reason": "<string>",
"estimated_arr": 123,
"contract_value": 123,
"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": 123,
"renews_at": "2024-12-20T16:04:11Z",
"current_phase_id": "<string>",
"display_shipping_details": true,
"properties": null,
"custom_properties": {},
"invoice_schedule": "period_start",
"generate_document": true,
"document_name": "<string>",
"add_tax_to_document": true,
"generate_draft_invoices": true,
"invoice_custom_note": "<string>",
"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": "once"
},
"payment_schedule": "start",
"type": "flat_fee",
"count": 1,
"prices": [
{
"type": "fee",
"amount": 123,
"id": "<string>"
}
]
}
],
"coupons": [
{
"description": null,
"expiration_date": null,
"redemption_limit": null,
"product_ids": [
"itm_FJKlqUb8COXw55"
],
"created_at": "2024-12-20T16:04:11Z",
"type": "amount",
"discount_amount": 2000,
"currency": "EUR",
"id": "cou_DKL4Xcb5VSa8CQ",
"promotion_code_id": null,
"name": "Partner discount",
"subscription_coupon_id": "coos_d9pVekhjoGppuX",
"repeat": "forever",
"duration_period": "days",
"duration_count": 123,
"apply_at": null,
"expires_at": null
}
]
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
0 <= x <= 100x >= 0checkout, contract_start_date, quote, start_date, manually checkout, contract_start_date, quote, start_date, manually all, inactive, active, errored, cancelled, paused, pending, draft, voided, archived all, inactive, active, errored, cancelled, paused, pending, draft, voided, archived Was this page helpful?