Subscriptions
Refresh seat products
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
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
201 - application/json
Subscription update ID.
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.
Available options:
immediately, next_period, custom Date when the subscription should be updated. UTC date time string in the ISO 8601 format.
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.
Available options:
immediately, next_invoice, custom 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.
Available options:
pro_rata, pay_in_full, do_not_charge Amount to adjust the subscription price.
Subscription ID.
Product ID.
Previous count.
New count.
The next refresh date. Exists if your seat item is configured to be refreshed periodically.
Was this page helpful?