Subscribe

Create subscription checkout

Changed on

Create a subscription checkout URL or a billing page link only after the user confirms. The request never completes payment by itself. An account with a plan gets the dashboard billing page, where the user signs in to manage billing.

post/subscribe

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/subscribe
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

tier'starter' | 'pro' | 'business'

Subscription tier to pre-select.

Example request

{
  "tier": "pro"
}

Response

Billing URL

urlstring uri required

Checkout URL, or the dashboard billing page for an account with a plan.

status'checkout_created' | 'already_subscribed' | 'payment_issue' required
messagestring required

Example response

{
  "url": "https://xquik.com/billing/session",
  "status": "checkout_created",
  "message": "Billing session created"
}

Changes

  • 245194cd4ea7Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

  • dea38c0d032dRevision changes
    • warning

      added the new x_video_too_large enum value to the ///// response property for the response status

    • warning

      added the new x_video_too_large enum value to the ////// response property for the response status

    • warning

      added the new x_video_too_large enum value to the / response property for the response status

    • warning

      added the new x_video_too_large enum value to the // response property for the response status