Docs

Preview License Change

POST /licenses/{licenseId}/preview

POST/licenses/{licenseId}/preview

Shows what a seat change or a product add would cost, without making it: the amount due today and the next renewal, in minor units. Send seats alone to resize this license, or seats with a product id to preview adding that product, as Licenses_AddLicense takes it. On a trial it also returns the renewal's subtotal and discount; send a payment method type of us_bank_account to include the bank account discount. Requires OrganizationAdmin. The license id comes from Licenses_GetLicenses and the product id from Billing_GetProducts.

Path Parameters

FieldTypeRequiredDescription
licenseIduuidRequired

Request Body

FieldTypeRequiredDescription
seatsintegerOptional
productIduuidOptional
paymentMethodTypestringOptional

Response

FieldTypeDescription
dueTodayinteger
nextRenewalinteger
subtotalinteger
discountinteger
taxinteger
currencystring| null