Docs

Confirm Trial

POST /subscriptions/trial/confirm

POST/subscriptions/trial/confirm

Confirms buying during a trial: records consent and sets a payment method now, so the trial runs to its end and converts then. Nothing is charged here; the default payment method is what stops the trial from canceling. Send either a new payment method (confirmationTokenId, from Stripe.js createConfirmationToken on the Payment Element) or one on file (paymentMethodId, from PaymentMethods_GetPaymentMethods), not both; seats optionally changes the core license's seats first. Requires OrganizationAdmin, an Idempotency-Key header and consent (disclosureVersion and the verbatim disclosedTerms the buyer saw). The outcome is Confirmed, VerificationPending (bank account microdeposits, with a hosted verification url and arrival date) or ActionRequired (with a client secret: run Stripe.js handleNextAction on it for 3D Secure, then retry with the same key). A declined card returns 402 with a declineCode.

Headers

FieldTypeRequiredDescription
Idempotency-KeystringOptional

Request Body

FieldTypeRequiredDescription
confirmationTokenIdstringOptional
paymentMethodIdstringOptional
seatsintegerOptional
consentConfirmTrialRequestConsentInfoOptional

ConfirmTrialRequestConsentInfo

FieldTypeDescription
disclosureVersionstring| null
disclosedTermsstring| null

Response

FieldTypeDescription
outcomestring| null
clientSecretstring| null
hostedVerificationUrlstring| null
verificationArrivalDatedate-time| null