Create subscription updates

Create multiple updates to apply at once to an existing subscription.

POST /v1/subscriptions/{id}/update-many

Create subscription updates

cURL

curl --request POST \
  --url https://api.hyperline.co/v1/subscriptions/{id}/update-many \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "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

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

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.

Add product

Remove product

Add coupon

Remove coupon

Update count

Update prices

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 updates created

id · string · required