GET
/
v2
/
subscriptions
/
{id}
/
phases
/
{phaseId}
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions/{id}/phases/{phaseId} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
phaseId
string
required

Response

200
application/json

The response is of type object.