Skip to main content
POST
/
v1
/
subscriptions
/
{id}
/
update
Create subscription update
curl --request POST \
  --url https://api.hyperline.co/v1/subscriptions/{id}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "product_id": "<string>",
    "billing_interval_count": 123,
    "product_name": "<string>",
    "product_description": "<string>",
    "count": 1,
    "display_interval_dates_in_description": true,
    "prices": [
      {
        "amount": 123
      }
    ]
  },
  "apply_at": "2024-12-20T16:04:11Z",
  "charge_at": "2024-12-20T16:04:11Z"
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json

Add a new product to bill as part of the subscription.

​
application_schedule
enum<string>
required
Available options:
immediately,
scheduled
​
payment_schedule
enum<string>
required
Available options:
immediately,
next_invoice,
custom
​
calculation_method
enum<string>
required
Available options:
pro_rata,
pay_in_full,
do_not_charge
​
type
required
Available options:
add_product
​
payload
object
required
​
apply_at
string<date-time>

The date when the update should be applied. Required when application_schedule is 'scheduled'.

Example:

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

​
charge_at
string<date-time>

The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.

Example:

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

​
refund_method
enum<string>

Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's creditNoteWalletRefundEnabled setting.

Available options:
wallet,
original_payment_method,
external

Response

Subscription update created

​
id
string
required