Create Stripe Checkout subscription session

post/billing/checkout-session

Request

  • Base URL: https://api.gravityads.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.gravityads.dev/billing/checkout-session
  • Auth: HTTP bearer

Request body

plan_idstring required
catalog_versionstring
account_countinteger
billing_interval'monthly' | 'annual'
request_keystring
success_urlstring uri required
cancel_urlstring uri required
customer_idstring
quantityinteger
promotion_codestring
allow_promotion_codesboolean
metadataobject

Response

Checkout session

status'stripe_checkout_session_created' | 'stripe_checkout_setup_required' | 'stripe_checkout_session_failed' required
tenant_idstring
plan_idstring
session_idstring
urlstring
client_secretstring
modestring
payment_statusstring
error_codestring
retryboolean
raw_secrets_returnedfalse required
subscriptionobject
customer_id_source'request' | 'control_plane_subscription' | 'none'
hosted_auth_contextobject
messagestring
billing_setup_requiredboolean
self_service_checkout_readyfalse
payment_collection_blockedboolean
tenant_bootstrappedboolean
internal_trial_activeboolean
safe_to_continue_read_only_setupboolean
raw_price_ids_returnedfalse

Changes

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