post/stripe/checkout/subscription

Create checkout session

Initiates a Stripe checkout session for user subscription purchases.

create_checkout_session

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "price_id": {
      "type": "string",
      "description": "The Stripe price ID for the subscription plan"
    },
    "country_code": {
      "type": "string",
      "description": "Two-letter country code used for regional pricing"
    },
    "client_geoip_country_code": {
      "type": "string",
      "description": "Two-letter country code observed by the client GeoIP store before checkout"
    },
    "eu_withdrawal_waiver_accepted": {
      "type": "boolean",
      "description": "Whether the EU/EEA digital content withdrawal waiver was expressly accepted before checkout"
    },
    "pricing_mode": {
      "$ref": "#/components/schemas/PricingModeEnum"
    },
    "payment_method": {
      "$ref": "#/components/schemas/CheckoutPaymentMethodEnum"
    },
    "is_business": {
      "type": "boolean",
      "description": "Whether the purchase is for a business. When true, Stripe Checkout requires a billing address (needed for tax invoicing). When false or omitted, billing address collection is left to Stripe (auto)."
    }
  },
  "required": [
    "price_id"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL to redirect to"
    }
  },
  "required": [
    "url"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}