Sign in
User APIs
auth

Create Checkout Session

Create Stripe Checkout session.

Validates:

  • Status is EMAIL_VERIFICATION_VERIFIED or PAYMENT_FAILED (allows retry)
  • Creates Stripe Checkout session for subscription
post/api/v1/auth/signup/{session_id}/checkout/create

Path parameters

session_idstring required

Request body

fbpstring nullable

Meta _fbp browser cookie

fbcstring nullable

Meta _fbc click ID cookie

marketing_consentboolean

Visitor granted the CMP's marketing category. Persisted on the signup so the Purchase webhook can honour it later (PRO-3255).

promo_codestring nullable

Curated ad-attribution promo slug (e.g. utm_campaign when utm_source='promo'); resolved server-side to a Stripe promotion code.

Response

Successful Response

session_idstring required
checkout_session_idstring required
client_secretstring nullable
urlstring nullable
statusstring required
capi_event_idstring nullable
purchase_capi_event_idstring nullable

Changes

Changed in 1 of the 4 revisions of this API.1

  • d1966b531e251See the full diff
    • ○

      added the new optional request property anyOf[subschema #1: CheckoutInitiateData]/marketing_consent

      new-optional-request-property