Create Checkout Session

POST /api/subscription/create-checkout

Creates a Stripe Checkout session to upgrade or subscribe to a paid plan (BASIC or PRO). Returns a session ID and URL to redirect the user to complete payment.

Authentication

This endpoint requires authentication. Include your access token in the request cookies.

Request Body

string

required

Plan to subscribe to. Options: BASIC, PRO

string

Promotional code for discounts (3-50 characters). Will be converted to uppercase

string

default:"monthly"

Billing period. Options: monthly, annual

Response

string

required

Stripe Checkout session ID

string

required

URL to redirect the user to complete the checkout process

string

required

Success message

Example Request

curl -X POST "https://api.contafy.com/api/subscription/create-checkout" \
  -H "Content-Type: application/json" \
  -H "Cookie: access_token=your_access_token" \
  -d '{
    "plan": "PRO",
    "promotionCode": "PROMO2024",
    "billing": "annual"
  }'

Example Response

{
  "sessionId": "cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
  "url": "https://checkout.stripe.com/c/pay/cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
  "message": "Checkout session created successfully"
}

Usage Flow

Call this endpoint to create a checkout session
Redirect the user to the returned url
User completes payment on Stripe’s hosted checkout page
User is redirected back to your success URL
Stripe webhook updates the subscription status

Error Responses

error

Authentication required or token expired

{
  "error": "Unauthorized",
  "message": "Authentication required"
}

error

Invalid request parameters

{
  "error": "Bad Request",
  "message": "Invalid plan. Must be BASIC or PRO"
}

error

User already has an active subscription to the requested plan

{
  "error": "Conflict",
  "message": "You are already subscribed to this plan"
}

error

Server or Stripe error occurred

{
  "error": "Internal Server Error",
  "message": "Failed to create checkout session"
}

The checkout session expires after 24 hours. Users must complete payment within this timeframe.

For annual billing, consider displaying the discount percentage to encourage upgrades.

Authentication

Profiles

Invoices

Expenses

Subscription

SAT Search

Create Checkout Session

POST /api/subscription/create-checkout

Authentication

Request Body

Response

Example Request

Example Response

Usage Flow

Error Responses

​POST /api/subscription/create-checkout

​Authentication

​Request Body

​Response

​Example Request

​Example Response

​Usage Flow

​Error Responses

POST /api/subscription/create-checkout

Authentication

Request Body

Response

Example Request

Example Response

Usage Flow

Error Responses