Skip to main content

createCustomCheckoutSession

Creates a hosted Stripe checkout session and returns its URL; completing checkout purchases the plan. Contacts Stripe and can create or link the billing customer, but fails when Stripe already holds a live or unpaid subscription for it. Use updateSubscriptionItems to change an existing subscription or createSubscription to pay in-app. Requires billing change plan access.

createCustomCheckoutSession(
  planPriceId: String!
  promotekitReferral: String
): CustomCheckoutSessionResult

Arguments​

createCustomCheckoutSession.planPriceId ● String! non-null scalar​

Stripe price ID from pricingGrid or a tier stripeId from tieredPricingPlans; not the numeric payment plan ID.

createCustomCheckoutSession.promotekitReferral ● String scalar​

Optional referral string; currently ignored by this operation.

Type​

CustomCheckoutSessionResult object​

Hosted checkout URL returned by createCustomCheckoutSession.