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

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

201 - application/json
id
string
required

Subscription update ID.

application_schedule
enum<string>
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.
Available options:
immediately,
next_period,
custom
apply_at
string
required

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

payment_schedule
enum<string>
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.
Available options:
immediately,
next_invoice,
custom
calculation_method
enum<string>
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.
Available options:
pro_rata,
pay_in_full,
do_not_charge
adjustment_amount
number | null
required

Amount to adjust the subscription price.

subscription_id
string
required

Subscription ID.

product_id
string
required

Product ID.

previous_count
number
required

Previous count.

new_count
number
required

New count.

next_refresh_date

The next refresh date. Exists if your seat item is configured to be refreshed periodically.

Was this page helpful?

Update subscriptionTransition subscription to next phase