Skip to main content
POST
/
v1
/
subscriptions
/
{id}
/
simulate-updates
Simulate subscription updates
curl --request POST \
  --url https://api.hyperline.co/v1/subscriptions/{id}/simulate-updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "application_schedule": "immediately",
  "payment_schedule": "immediately",
  "calculation_method": "pro_rata",
  "updates": [
    {
      "type": "add_product",
      "payload": {
        "product_id": "<string>",
        "billing_interval_period": "days",
        "billing_interval_count": 123,
        "start_or_end": "start",
        "type": "fee",
        "prices": [
          {
            "type": "fee",
            "amount": 123
          }
        ],
        "product_name": "<string>",
        "product_description": "<string>",
        "count": 1,
        "display_interval_dates_in_description": true
      }
    }
  ],
  "apply_at": "2024-12-20T16:04:11Z"
}
'
{
  "amount": 123
}

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
​
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
​
updates
(Add product · object | Remove product · object | Add coupon · object | Remove coupon · object | Update count · object | Update prices · object)[]
required

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

​
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

Simulation results

​
amount
number
required