Upgrade Offers

Execute Upgrade Offer

Changed on

Executes a subscription upgrade, creating a new payment intent or checkout session for the target product. The old subscription is cancelled with proration when the new payment succeeds.

post/iap/upgrade-offer/execute

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/upgrade-offer/execute
  • Auth
    API key in header X-ZeroSettle-Key

Request body

user_idstring required

The user's external ID.

current_product_idstring required

The reference ID of the user's current subscription product.

target_product_idstring required

The reference ID of the product to upgrade to.

Response

Upgrade initiated

type'web_to_web' | 'storekit_to_web'

The type of upgrade being performed.

client_secretstring

Stripe PaymentIntent client secret for confirming the upgrade payment.

checkout_urlstring

Fallback checkout URL.

transaction_idstring

ZeroSettle transaction ID for the upgrade.

Changes