Skip to main content
POST
/
v1
/
subscriptions
/
{id}
/
reactivate
Reactivate subscription
curl --request POST \
  --url https://api.hyperline.co/v1/subscriptions/{id}/reactivate \
  --header 'Authorization: Bearer <token>'
{
  "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,
  "transition_from_subscription_id": null,
  "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": 123,
  "cancellation_reason": "<string>",
  "estimated_arr": 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>",
  "properties": null,
  "custom_properties": {},
  "generate_document": true,
  "document_name": "<string>",
  "add_tax_to_document": true,
  "generate_draft_invoices": true,
  "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": "<any>",
          "id": "<any>",
          "amount": "<any>"
        }
      ]
    }
  ],
  "coupons": [
    {
      "description": null,
      "expiration_date": null,
      "redemption_limit": null,
      "product_ids": {
        "0": "itm_FJKlqUb8COXw55",
        "1": "itm_1234567890abcdef"
      },
      "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
    }
  ],
  "phases": [
    {
      "id": "sup_1FoLfIQ5VOMbXf",
      "type": "standard",
      "status": "pending",
      "order": 0,
      "activation_strategy": "manual",
      "end_strategy": "duration",
      "duration": {
        "count": 1,
        "period": "years"
      },
      "billing_date_setting": "phase_start",
      "initial_billing_at": null,
      "starts_at": null,
      "ends_at": null,
      "billing_cycle_alignment": "anniversary",
      "do_not_invoice_phase": false,
      "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": "once"
          },
          "payment_schedule": "start",
          "type": "flat_fee",
          "count": 1,
          "prices": [
            {
              "type": "<any>",
              "id": "<any>",
              "amount": "<any>"
            }
          ]
        }
      ],
      "coupons": [
        {
          "description": null,
          "expiration_date": null,
          "redemption_limit": null,
          "product_ids": {
            "0": "itm_FJKlqUb8COXw55",
            "1": "itm_1234567890abcdef"
          },
          "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
        }
      ],
      "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"
  },
  "template": {
    "id": "subt_7gdusOkqr5L0B8",
    "name": "My example template",
    "configurationId": "subtc_7mHWOlPStUogvp"
  },
  "checkout_session": {
    "id": "che_hEUPdVG7IgjpW1",
    "status": "opened",
    "available_payment_methods": [
      "card"
    ],
    "redirect_url": "https://app.hyperline.co/callback/checkout",
    "send_to": {
      "email": "[email protected]",
      "message": null
    },
    "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": "2027-11",
    "brand": "visa"
  },
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required
Example:
​
name
string | null
required
Example:
​
currency
enum<string>
required
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:
​
status
enum<string>
required
Available options:
active,
cancelled,
draft,
errored,
paused,
pending,
voided
Example:
​
purchase_order
string | null
required
​
customer_id
string
required
Example:
​
invoicing_entity_id
string
required
Example:
​
plan_id
string | null
required
deprecated
Example:
​
template_id
string | null
required
Example:
​
checkout_session_id
string | null
required
​
crm_opportunity_id
string | null
required
Example:
​
transition_from_subscription_id
string | null
required
Example:
​
minimum_invoice_fee
number | null
required
Example:
​
commitment_interval
object | null
required
deprecated
Example:
​
renew_automatically
boolean
required
Example:
​
renew_for
object | null
required
Example:
​
activation_strategy
enum<string> | null
required
Available options:
start_date,
manually,
checkout,
quote,
contract_start_date
Example:
​
starts_at
string<date-time> | null
required
deprecated
Example:
​
contract_start
string<date-time> | null
required
Example:
​
contract_end
string<date-time> | null
required
Example:
​
initial_billing_at
string<date-time> | null
required
Example:
​
paused_at
string<date-time> | null
required
Example:
​
reactivate_at
string<date-time> | null
required
Example:
​
cancel_at
string<date-time> | null
required
Example:
​
cancellation_strategy
enum<string> | null
required
Available options:
refund_prorata,
refund_custom,
charge_prorata,
charge_custom,
end_of_period,
do_nothing
​
cancellation_amount
number | null
required
​
cancellation_reason
string | null
required
​
estimated_arr
number | null
required
​
current_period_started_at
string<date-time> | null
required
Example:
​
current_period_ends_at
string<date-time> | null
required
Example:
​
next_payment_at
string<date-time> | null
required
Example:
​
next_payment_amount
number | null
required
​
renews_at
string<date-time> | null
required
Example:
​
current_phase_id
string | null
required
​
properties
object | null
required
Example:
​
custom_properties
object | null
required
​
generate_document
boolean
required
​
document_name
string | null
required
​
add_tax_to_document
boolean
required
​
generate_draft_invoices
boolean
required
​
created_at
string<date-time>
required
Example:
​
updated_at
string<date-time>
required
Example:
​
products
(Fee product · object | Seat product · object | Dynamic product · object | Credit product · object)[]
required
  • Fee product
  • Seat product
  • Dynamic product
  • Credit product
​
coupons
(Coupon amount · object | Coupon percent · object)[]
required
  • Coupon amount
  • Coupon percent
​
phases
object[]
required
​
quote
object | null
required
​
plan
object | null
required
​
template
object | null
required
​
checkout_session
object | null
required
​
payment_method_type
enum<string> | null
required
Available options:
card,
apple_pay,
google_pay,
direct_debit,
direct_debit_ach,
direct_debit_bacs,
stripe_link,
transfer,
transfer_automated,
external
​
payment_method
object | null
required
  • Card
  • Card (errored)
  • Direct Debit
  • Direct Debit (errored)
​
contract_terms
object | null
required