v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Subscriptions

Refresh seat products

Triggers 'count' updates on connected seat products within the subscription. This action will use the dataloader query to retrieve and update the number of units for each seat product.

post/v2/subscriptions/{id}/refresh-seat-products

Path parameters

idstring required

Response

idstring required

Subscription update ID.

application_schedule'immediately' | 'next_period' | 'custom' | 'scheduled' required

Indicates when the subscription should be updated.

immediately: The subscription will be updated immediately.
next_period: The subscription will be updated at the end of the current billing period.
custom: The subscription will be updated at a custom date.

apply_atstring date required

Date when the subscription should be updated. UTC date time string in the ISO 8601 format.

payment_schedule'immediately' | 'next_invoice' | 'custom' required

Indicates when the subscription should be billed.

immediately: The subscription will be billed immediately.
next_invoice: The subscription will be billed at the next invoice.
custom: The subscription will be billed at a custom date.

calculation_method'pro_rata' | 'pay_in_full' | 'do_not_charge' required

Indicates how the products price should be calculated.

pro_rata: The price will be calculated proportionally to the time elapsed since the last billing period.
pay_in_full: The price will be calculated for the entire billing period.
do_not_charge: The price will not be calculated.

adjustment_amountnumber nullable required

Amount to adjust the subscription price.

subscription_idstring required

Subscription ID.

product_idstring required

Product ID.

previous_countnumber required

Previous count.

new_countnumber required

New count.

Example response

[
  {
    "id": "supd_MkTDgpM6ej6f8l",
    "apply_at": "2024-11-30T18:24:34.496Z",
    "subscription_id": "sub_7aWtG7Gb_fwGno",
    "product_id": "itm_G6nU9iSC7eoDsk",
    "previous_count": 2,
    "new_count": 7
  }
]