Complete a self-serve upgrade

Reconciles the subscription change after the Chargebee hosted page redirects back, and returns the plan now active. Idempotent — calling it twice for the same hosted page yields the same result.

post/v1/billing/upgrade/complete

Request

Base URL: https://api.prod.keyban.io
URL: https://api.prod.keyban.io/v1/billing/upgrade/complete
Auth: bearer (a scheme the document does not define)

Request body

hostedPageIdstring required

Chargebee hosted page ID the upgrade checkout redirected back with, used to reconcile the completed plan change.

Example request

{
  "hostedPageId": "hp_AzYy7hSFSDadZ4Rd"
}

Response

Upgrade applied, plan now active on the subscription

planIdstring required

Chargebee item ID of the plan now active on the subscription (e.g. "agent-wallet-growth-plan-v2").

itemPriceIdstring required

Chargebee item-price ID now active on the subscription (e.g. "agent-wallet-growth-plan-v2-eur-monthly").

Example response

{
  "planId": "agent-wallet-growth-plan-v2",
  "itemPriceId": "agent-wallet-growth-plan-v2-eur-monthly"
}

Changes

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