Skip to main content

Checkout a product or subscription​

Checkout a product to buy it one time or start a subscription plan on a billing account.

Path Parameters
    org_id string required
Request Body required
    billing_id ID of the billing account to update the subscription for
    success_url string
    cancel_url string
    subscription_body object
    plan string
    skip_trial boolean
    cancel_after_trial boolean
    provider_coupon_id provider_coupon_id is the coupon code that will be applied to the subscription generated by the billing provider, this will be deprecated once coupons are managed by the platform
    product_body object
    product string
    quantity int64
    setup_body object
    payment_method boolean
    customer_portal boolean
Responses

A successful response.

Schema
    checkout_session object
    id string
    checkout_url string
    success_url string
    cancel_url string
    state string
    plan string
    product string
    metadata object
    created_at date-time
    updated_at date-time
    expire_at date-time
Loading...