Organizations

Confirm a self-service plan change

post/organizations/{organizationId}/plan-change/confirm

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/organizations/{organizationId}/plan-change/confirm
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of Organization

Request body

plan_namestring required
billing_cycle'monthly' | 'yearly'
seatsinteger
request_idstring

Optional client-supplied idempotency/request identifier. If omitted, the API Gateway request id is forwarded to billing.

checkout_return_urlstring

Optional absolute dashboard URL used as Mollie redirect target after checkout.

Response

Plan change accepted

status'applied' | 'scheduled' | 'checkout_required' | 'blocked' | 'canceled'
messagestring
error_codestring

Typed reason when billing refuses the checkout a confirm needs, passed through with billing's 4xx status: billing_email_invalid, checkout_return_url_invalid, checkout_return_url_not_allowed, checkout_request_invalid, payment_method_exists or payment_method_not_found. Absent on other responses.

request_idstring
change_idstring
requested_atstring
requested_by_emailstring
requested_by_user_idstring
current_plan_namestring
target_plan_namestring
current_billing_cycle'monthly' | 'yearly'
target_billing_cycle'monthly' | 'yearly'
current_seatsinteger
target_seatsinteger
effective_datestring
payment_method_requiredboolean
pending_checkoutboolean

True when the target plan is waiting for checkout/payment mandate completion and has not been applied.

checkout_urlstring
hubspot_notification_requiredboolean
internal_notification_requiredboolean
has_partner_termsboolean
has_discount_termsboolean
blockersstring[]

Example response

{
  "error_code": "billing_email_invalid"
}

Changes

No recorded changes to this operation across all 1 revision of this API.