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 '{
  "application_schedule": "immediately",
  "apply_at": "2024-12-20T16:04:11Z",
  "payment_schedule": "immediately",
  "calculation_method": "pro_rata",
  "type": "add_product",
  "payload": {
    "product_id": "<string>",
    "product_name": "<string>",
    "product_description": "<string>",
    "count": 1,
    "billing_interval_period": "days",
    "billing_interval_count": 123,
    "start_or_end": "start",
    "display_interval_dates_in_description": true,
    "type": "fee",
    "prices": [
      {
        "type": "fee",
        "amount": 123
      }
    ]
  }
}'
{
  "id": "<string>"
}

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
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6

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
​
calculation_method
enum<string>
required
Available options:
pro_rata,
pay_in_full,
do_not_charge
​
type
required
Available options:
add_product
​
payload
object
required
  • Option 1
  • Option 2
  • Option 3
​
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"

Response

Subscription update created

​
id
string
required