Create subscription update

Create an update to apply on an existing subscription.

POST /v1/subscriptions/{id}/update

Create subscription update

cURL

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"
}
'

201

{
  "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

Add product

Remove product

Add coupon

Remove coupon

Update count

Update prices

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 · Option 1 · enum<string> Option 2 · enum<string> · required

Available options: add_product

payload · object · required

Option 1

Option 2

Option 3

Show child attributes

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"

Response

201

application/json

Subscription update created

id · string · required