Get subscription

GET

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",
      "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": "calendar_period",
      "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",
          "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

Authorization

string

header

required

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

Path Parameters

string

required

Query Parameters

include_live_billing

string

Response

200

application/json

string

required

Subscription ID.

Example:

"sub_B6ClkdqNqVNBgY"

currency

enum<string>

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

status

enum<string>

required

Subscription status.

draft: The subscription is being created, this status is only used in the subscription assignation flow of the UI version of Hyperline.
pending: The subscription has been created and won't be charged until it is activated.
active: The subscription is running and will be invoiced at the next payment date.
paused: The subscription's payment collection is paused.
cancelled: The subscription has been canceled from an active state.
voided: The subscription has been voided directly from the pending state.
errored: We attempted 4 times (3 retries) and failed to charge a subscription's invoice, see Handling payment errors. We consider the subscription as inactive (as the customer failed to pay you) meaning that we won't invoice the customer in the future nor collect payment. You can choose to reactivate it manually.

Available options:

active,

cancelled,

draft,

errored,

paused,

pending,

voided

Example:

"active"

purchase_order

string | null

required

Reference to the purchase order.

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

plan_id

string | null

required

ID of the plan used to create the subscription.

Example:

"plan_zHmjoDee4ZRmQV"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the subscription.

Example:

"ive_jerrb484RHn"

checkout_session_id

string | null

required

ID of the checkout session.

crm_opportunity_id

string | null

required

ID of the related opportunity/deal in the connected CRM.

minimum_invoice_fee

number | null

required

Minimum fee applied to each invoice outside of one time payments.

Example:

250

commitment_interval

object | null

required

deprecated

Use contract_terms instead. Interval previously used to represent the commitment period of the subscription.

Example:

{ "period": "years", "count": 1 }

renew_automatically

boolean

required

Use contract_terms instead. Indicates if the subscription should automatically renew.

Example:

true

renew_for

object | null

required

Use contract_terms instead. If renew_automatically is enabled, will renew the subscription for the given interval.

Example:

{ "period": "years", "count": 1 }

activation_strategy

enum<string> | null

required

Strategy used to activate the subscription.

start_date: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.
manually: The subscription requires activation through a manual action.
checkout: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.
quote: The subscription will be activated depending on the configuration and the signature of the related quote.

Available options:

start_date,

manually,

checkout,

quote,

contract_start_date

Example:

"checkout"

starts_at

string

required

deprecated

Applies only if the activation strategy is start_date. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

contract_start

string

required

Use contract_terms instead. Subscription contract start date. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

contract_end

string | null

required

Use contract_terms instead. Subscription contract end date. UTC date time string in the ISO 8601 format.

Example:

"2025-01-15T00:00:00Z"

initial_billing_at

string | null

required

Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

paused_at

string | null

required

Date when the subscription was paused. Only applies to paused status. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

reactivate_at

string | null

required

Date when the subscription will be automatically reactivated. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

cancel_at

string | null

required

Subscription cancel date. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

cancellation_strategy

enum<string> | null

required

Strategy used to cancel the subscription. If not specified do_nothing is used.

charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.
charge_custom: Will charge the customer a custom amount.
refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.
refund_custom: Will refund to the customer a custom amount.
end_of_period: Will cancel the subscription at the end date of the current billing period.
do_nothing: Will only cease the subscription without any additional actions.

Available options:

refund_prorata,

refund_custom,

charge_prorata,

charge_custom,

end_of_period,

do_nothing

cancellation_amount

number

required

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

Example:

24000

estimated_arr

number

required

Estimated Annual Recurring Revenue generated by the subscription.

Example:

24000

current_period_started_at

string | null

required

Start date of the current billing period. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

current_period_ends_at

string | null

required

End date of the current billing period. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

next_payment_at

string | null

required

Date on which the next subscription payment will occur. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

next_payment_amount

number

required

The amount of the next subscription payment. The system will generate an invoice to pay on the next_payment_at.

Example:

24000

renews_at

string | null

required

Next subscription commitment renewal date. UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

current_phase_id

string | null

required

ID of the current subscription phase.

properties

object | null

required

Key/value pairs to store any information you find useful.

custom_properties

object | null

required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

created_at

string

required

Subscription creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-12T07:00:01.860Z"

updated_at

string

required

Subscription last edition date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-12T07:00:01.860Z"

products

object[]

required

Products that make up the subscription.

products.id

string

required

Product ID.

Example:

"itm_FJKlqUb8COXw55"

products.name

string

required

Product name. This will appear on the final invoices.

Example:

"Product name"

products.description

string | null

required

Product description. This will appear on the final invoices.

Example:

"A description of the product."

products.description_display_interval_dates

boolean

required

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

products.attached_at

string | null

required

Date on which the product has been attached to the subscription. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

products.detached_at

string | null

required

Date on which the product has been detached from the subscription. UTC date time string in the ISO 8601 format.

Example:

"2024-04-15T00:00:00Z"

products.current_period_started_at

string | null

required

Date on which the current period started. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

products.current_period_ends_at

string | null

required

Date on which the current period will end. UTC date time string in the ISO 8601 format.

Example:

"2024-02-15T00:00:00Z"

products.next_payment_at

string | null

required

Date on which the next subscription product payment will occur. UTC date time string in the ISO 8601 format.

Example:

"2024-02-15T00:00:00Z"

products.payment_interval

object | null

required

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

Example:

{ "period": "months", "count": 1 }

products.payment_schedule

enum<string> | null

required

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

Example:

"start"

products.type

enum<string>

required

Available options:

flat_fee

products.count

number

required

Number of product units.

Example:

1

products.prices

object[]

required

Price tiers of the product. If fixed amount, only one price is available.

coupons

object[]

required

Coupons to be applied to the prices of subscription products.

coupons.description

string | null

required

Coupon description.

coupons.expiration_date

string | null

required

Date corresponding to the expiration of the coupon.

Example:

"2024-10-13T02:00:00.000Z"

coupons.redemption_limit

number | null

required

Maximum number of subscriptions to which a single coupon can be applied.

coupons.created_at

string

required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

coupons.type

enum<string>

required

Available options:

amount

coupons.discount_amount

number

required

Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.

Example:

2000

coupons.currency

enum<string>

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

coupons.id

string | null

required

Coupon ID.

Example:

"cou_DKL4Xcb5VSa8CQ"

coupons.name

string | null

required

Coupon name.

Example:

"Partner discount"

coupons.subscription_coupon_id

string

required

Coupon identifier in the context of the subscription.

Example:

"coos_d9pVekhjoGppuX"

coupons.repeat

enum<string>

required

Coupon frequency.

once: Will apply the coupon only to the first one invoice.
forever: Will apply the coupon to all invoices.
custom: Will apply to coupon until a specified expiration date.

Available options:

once,

forever,

custom

Example:

"forever"

coupons.product_ids

string[]

required

Product IDs to which the coupon will be applied.

Example:

["itm_FJKlqUb8COXw55"]

coupons.apply_at

string | null

required

Coupon first application date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

coupons.expires_at

string | null

required

Coupon expiration date. Only applies to the custom coupon frequency. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases

object[]

required

Phases of the subscription.

phases.id

string

required

Subscription phase ID.

Example:

"sup_1FoLfIQ5VOMbXf"

phases.type

enum<string>

required

Type of subscription phase.

setup: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.
trial: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.
standard: The phase represents a standard recurring billing.

Available options:

setup,

trial,

standard

Example:

"standard"

phases.status

enum<string>

required

Status of subscription phase.

pending: The phase is waiting to start (not started yet).
active: The phase is currently in progress.
finished: The phase has ended and is complete.

Available options:

pending,

active,

finished

Example:

"active"

phases.order

number

required

Order in which the phase is executed within all subscription phases.

Example:

0

phases.activation_strategy

enum<string>

required

Activation strategy of subscription phase.

immediately: The phase starts as soon as the subscription is activated.
manual: The phase starts when a user manually activates it.
start_date: The phase starts on a specified date.
quote_signature: The phase starts when the subscription quote is signed.
checkout: The phase starts when the subscription checkout is completed.
contract_start_date: The phase starts on the start date of the related subscription contract.
previous_phase_end: The phase starts when the previous phase ends.

Available options:

immediately,

manual,

start_date,

quote_signature,

checkout,

contract_start_date,

previous_phase_end

Example:

"manual"

phases.end_strategy

enum<string>

required

End strategy of subscription phase.

manual: The phase ends when a user manually stops it.
end_date: The phase ends on a specified date.
duration: The phase ends after a specific relative duration.
contract_end_date: The phase ends on the end date of the related subscription contract.

Available options:

manual,

end_date,

duration,

contract_end_date

Example:

"duration"

phases.duration

object | null

required

Interval over which the subscription phase spans. Only applies to duration end strategy.

Example:

{ "count": 1, "period": "years" }

phases.billing_date_setting

enum<string>

required

Represents when the first billing date occurs.

phase_start: Aligns with the start of the phase.
specific_date: Occurs on a specified date.

Available options:

phase_start,

specific_date

Example:

"phase_start"

phases.initial_billing_at

string | null

required

Date when the subscription phase will start being billed. Only applies to specific_date billing date setting. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases.starts_at

string | null

required

Actual start date of the phase. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases.ends_at

string | null

required

Actual end date of the phase. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases.billing_cycle_alignment

enum<string>

required

Alignment of product billing cycles.

calendar_period: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
anniversary: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.

Available options:

calendar_period,

anniversary

phases.transition_calculation_method

enum<string>

required

Calculation method used when transitioning from one phase to the next one.

prorata: The prorated amount between the two phases relative to the end date (the transition date) must be paid.
pay_in_full: The full amount for the phase billing period must be paid.
none: No amount will need to be paid, phase will simply transition from one to the next.

Available options:

prorata,

pay_in_full,

none

Example:

"prorata"

phases.transition_invoicing_schedule

enum<string>

required

Represents when the transition amount will be invoiced.

immediately: An invoice will be generated immediately with the corresponding amount.

Available options:

immediately

Example:

"immediately"

phases.products

object[]

required

Products comprising the subscription phase.

phases.products.id

string

required

Product ID.

Example:

"itm_FJKlqUb8COXw55"

phases.products.name

string

required

Product name. This will appear on the final invoices.

Example:

"Product name"

phases.products.description

string | null

required

Product description. This will appear on the final invoices.

Example:

"A description of the product."

phases.products.description_display_interval_dates

boolean

required

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

phases.products.attached_at

string | null

required

Date on which the product has been attached to the subscription. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

phases.products.detached_at

string | null

required

Date on which the product has been detached from the subscription. UTC date time string in the ISO 8601 format.

Example:

"2024-04-15T00:00:00Z"

phases.products.current_period_started_at

string | null

required

Date on which the current period started. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

phases.products.current_period_ends_at

string | null

required

Date on which the current period will end. UTC date time string in the ISO 8601 format.

Example:

"2024-02-15T00:00:00Z"

phases.products.next_payment_at

string | null

required

Date on which the next subscription product payment will occur. UTC date time string in the ISO 8601 format.

Example:

"2024-02-15T00:00:00Z"

phases.products.payment_interval

object | null

required

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

Example:

{ "period": "months", "count": 1 }

phases.products.payment_schedule

enum<string> | null

required

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

Example:

"start"

phases.products.type

enum<string>

required

Available options:

flat_fee

phases.products.count

number

required

Number of product units.

Example:

1

phases.products.prices

object[]

required

Price tiers of the product. If fixed amount, only one price is available.

phases.coupons

object[]

required

Coupons comprising the subscription phase.

phases.coupons.description

string | null

required

Coupon description.

phases.coupons.expiration_date

string | null

required

Date corresponding to the expiration of the coupon.

Example:

"2024-10-13T02:00:00.000Z"

phases.coupons.redemption_limit

number | null

required

Maximum number of subscriptions to which a single coupon can be applied.

phases.coupons.created_at

string

required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

phases.coupons.type

enum<string>

required

Available options:

amount

phases.coupons.discount_amount

number

required

Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.

Example:

2000

phases.coupons.currency

enum<string>

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

phases.coupons.id

string | null

required

Coupon ID.

Example:

"cou_DKL4Xcb5VSa8CQ"

phases.coupons.name

string | null

required

Coupon name.

Example:

"Partner discount"

phases.coupons.subscription_coupon_id

string

required

Coupon identifier in the context of the subscription.

Example:

"coos_d9pVekhjoGppuX"

phases.coupons.repeat

enum<string>

required

Coupon frequency.

once: Will apply the coupon only to the first one invoice.
forever: Will apply the coupon to all invoices.
custom: Will apply to coupon until a specified expiration date.

Available options:

once,

forever,

custom

Example:

"forever"

phases.coupons.product_ids

string[]

required

Product IDs to which the coupon will be applied.

Example:

["itm_FJKlqUb8COXw55"]

phases.coupons.apply_at

string | null

required

Coupon first application date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases.coupons.expires_at

string | null

required

Coupon expiration date. Only applies to the custom coupon frequency. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T02:00:00.000Z"

phases.created_at

string

required

Subscription phase creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-12T07:00:01.860Z"

phases.updated_at

string

required

Subscription phase last edition date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-12T07:00:01.860Z"

quote

object | null

required

plan

object | null

required

checkout_session

object | null

required

Checkout session of the subscription.

checkout_session.id

string

required

Checkout session ID.

Example:

"che_hEUPdVG7IgjpW1"

checkout_session.status

enum<string>

required

Checkout session current status.

Available options:

opened,

completed,

cancelled,

errored

Example:

"opened"

checkout_session.available_payment_methods

enum<string>[]

required

Types of payment method available on the checkout session.

Available options:

card,

direct_debit,

direct_debit_ach,

direct_debit_bacs,

transfer,

transfer_automated

Example:

["card"]

checkout_session.redirect_url

string | null

required

URL to which the user is automatically redirected after the completion of the checkout.

Example:

"https://app.hyperline.co/callback/checkout"

checkout_session.send_to

object | null

required

checkout_session.url

string

required

URL to access the checkout session. Only defined if the status is opened.

Example:

"https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1"

payment_method_type

enum<string> | null

required

Payment method type used to pay the subscription.

Available options:

card,

direct_debit,

direct_debit_ach,

direct_debit_bacs,

transfer,

transfer_automated,

external

payment_method

object | null

required

Payment method details used to pay the subscription.

generate_draft_invoices

boolean

required

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

contract_terms

object | null

required

Contract terms linked to the subscription.

contract_terms.status

enum<string>

required

Contract status.

active: The contract is active.
pending: The contract is pending. It will be activated according to the activation strategy.
finished: The contract has ended.

Available options:

active,

pending,

finished

Example:

"active"

contract_terms.activation_strategy

enum<string>

required

Activation strategy of the contract.

immediately: The contract will be activated immediately.
manual: The contract will be activated when a user manually activates it.
start_date: The contract will be activated on a specified date.
quote_signature: The contract will be activated when the subscription quote is signed.
checkout: The contract will be activated when the subscription checkout is completed.

Available options:

start_date,

immediately,

manual,

quote_signature,

checkout

Example:

"start_date"

contract_terms.end_strategy

enum<string>

required

End strategy of contract.

manual: The contract ends when a user manually stops it.
end_date: The contract ends on a specified date.
duration: The contract ends after a specific relative duration, unless renew_automatically is true.

Available options:

end_date,

duration,

manual

Example:

"duration"

contract_terms.starts_at

string | null

required

Start date of the contract. UTC date time string in the ISO 8601 format.

Example:

"2024-12-31T23:00:00.000Z"

contract_terms.ends_at

string | null

required

End date of the contract. UTC date time string in the ISO 8601 format.

Example:

"2025-06-30T21:59:59.999Z"

contract_terms.duration

object | null

required

Interval over which the contract initially spans. Only applies to duration end strategy.

Example:

{ "count": 6, "period": "months" }

contract_terms.renew_automatically

required

Indicates if the contract should be renewed automatically.

true: The contract will be renewed automatically.
false: The contract will not be renewed automatically.

Example:

true

contract_terms.renew_for_duration

object | null

required

Interval over which the contract will be renewed. Only applies if renew_automatically is true.

Example:

{ "count": 1, "period": "years" }

contract_terms.current_period_started_at

string | null

required

Start date of the current contract period. UTC date time string in the ISO 8601 format.

Example:

"2025-06-30T22:00:00.000Z"

contract_terms.current_period_ends_at

string | null

required

End date of the current contract period. UTC date time string in the ISO 8601 format.

Example:

"2026-06-30T21:59:59.999Z"

live_billing

object

Get subscriptions Get subscription phases

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",
      "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": "calendar_period",
      "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",
          "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>"
        ]
      }
    ]
  }
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Path Parameters

Query Parameters

Response