POST
/
v1
/
subscriptions
/
{id}
/
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",
  "payment_schedule": "immediately",
  "calculation_method": "pro_rata",
  "type": "add_item",
  "payload": {
    "product_id": "<string>",
    "count": 123,
    "billing_interval_period": "days",
    "billing_interval_count": 123,
    "product_name": "<string>",
    "product_description": "<string>",
    "start_or_end": "start",
    "display_interval_dates_in_description": true,
    "prices": [
      {
        "type": "fee",
        "amount": 123
      }
    ],
    "type": "fee"
  }
}'
{
  "id": "<string>"
}

Authorizations

Authorization
string
headerrequired

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
payment_schedule
enum<string>
required
Available options:
immediately
calculation_method
enum<string>
required
Available options:
pro_rata,
pay_in_full,
do_not_charge
type
enum<string>
required
Available options:
add_item
payload
object
required

Response

201 - application/json
id
string
required
Refresh subscriptionsCancel subscription