@emulates/flex 2.3.1

package/openapi.yaml

@@ -0,0 +1,1180 @@
+openapi: 3.1.0
+info:
+  title: Flex HSA/FSA payments API (Emulates subset)
+  description: |
+    Stateful mock subset of the Flex (withflex.com) payments API: products, checkout sessions
+    (payment, subscription, off-session and setup modes), subscriptions, customers, setup
+    intents, refunds, and the hosted checkout page. Request and response bodies are wrapped in an envelope named after the
+    object (`{product: {...}}`, `{checkout_session: {...}}`, `{products: [...]}`).
+    Hand-authored from the consumer's wire shapes and the Flex API reference
+    (https://docs.withflex.com/api-reference); Flex publishes no machine-readable spec.
+  version: "1"
+  x-emulates-upstream:
+    note: >-
+      Hand-authored from the wire shapes our consumer reads and writes (flex-api.client.ts,
+      flex-payment.types.ts, flex-product.types.ts, flex-webhook.service.ts,
+      do-flex-hosted-checkout.ts). Subscription mode, recurring price_data and the Subscription
+      object follow https://docs.withflex.com/api-reference/checkout-sessions/create-checkout-session,
+      https://docs.withflex.com/api-reference/subscriptions/get-subscription and
+      https://docs.withflex.com/api-reference/prices/create-price.
+servers:
+  - url: https://api.withflex.com
+security:
+  - bearerAuth: []
+paths:
+  /v1/products:
+    get:
+      operationId: ListProducts
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+        - name: starting_after
+          in: query
+          required: false
+          description: The last product_id of the previous page.
+          schema:
+            type: string
+            x-emulates-resource-ref:
+              type: product
+              missing: fprod_00000000000000000000000000
+      responses:
+        "200":
+          description: A page of products, oldest first
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ProductList"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+    post:
+      operationId: CreateProduct
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateProductBody"
+      responses:
+        "200":
+          description: The created product
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ProductEnvelope"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+  /v1/products/{productId}:
+    parameters:
+      - name: productId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: product
+            missing: fprod_00000000000000000000000000
+    get:
+      operationId: GetProduct
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: The product
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ProductEnvelope"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+    patch:
+      operationId: UpdateProduct
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateProductBody"
+      responses:
+        "200":
+          description: The updated product (emits product.updated)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ProductEnvelope"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /v1/checkout/sessions:
+    get:
+      operationId: ListCheckoutSessions
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: client_reference_id
+          in: query
+          required: false
+          schema:
+            type: string
+            maxLength: 255
+        - name: expand_customer
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: ["true", "false"]
+        - name: expand_payment_intent
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: ["true", "false"]
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+        - name: starting_after
+          in: query
+          required: false
+          schema:
+            type: string
+            x-emulates-resource-ref:
+              type: checkout_session
+              missing: fcs_00000000000000000000000000
+      responses:
+        "200":
+          description: Sessions, newest first
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CheckoutSessionList"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+    post:
+      operationId: CreateCheckoutSession
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      parameters:
+        - name: Idempotency-Key
+          in: header
+          required: false
+          schema:
+            type: string
+            minLength: 1
+            maxLength: 255
+            pattern: "^[A-Za-z0-9:_.-]+$"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateCheckoutSessionBody"
+      responses:
+        "200":
+          description: >-
+            The created session. Off-session mode charges the saved payment method before
+            answering, so the session is already complete (or its payment intent failed).
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CheckoutSessionEnvelope"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+        "409":
+          $ref: "#/components/responses/Error"
+        "500":
+          $ref: "#/components/responses/Error"
+  /v1/checkout/sessions/{sessionId}:
+    parameters:
+      - name: sessionId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: checkout_session
+            missing: fcs_00000000000000000000000000
+    get:
+      operationId: GetCheckoutSession
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: expand_customer
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: ["true", "false"]
+        - name: expand_payment_intent
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: ["true", "false"]
+      responses:
+        "200":
+          description: The session
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CheckoutSessionEnvelope"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /v1/checkout/sessions/{sessionId}/refund:
+    parameters:
+      - name: sessionId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: checkout_session
+            missing: fcs_00000000000000000000000000
+    post:
+      operationId: RefundCheckoutSession
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      parameters:
+        - name: Idempotency-Key
+          in: header
+          required: false
+          schema:
+            type: string
+            minLength: 1
+            maxLength: 255
+            pattern: "^[A-Za-z0-9:_.-]+$"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RefundCheckoutSessionBody"
+      responses:
+        "200":
+          description: The session with amount_refunded updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CheckoutSessionEnvelope"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+        "409":
+          $ref: "#/components/responses/Error"
+  /v1/customers:
+    post:
+      operationId: CreateCustomer
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      parameters:
+        - name: Idempotency-Key
+          in: header
+          required: false
+          schema:
+            type: string
+            minLength: 1
+            maxLength: 255
+            pattern: "^[A-Za-z0-9:_.-]+$"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateCustomerBody"
+      responses:
+        "200":
+          description: The created customer
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CustomerEnvelope"
+        "400":
+          $ref: "#/components/responses/Error"
+        "401":
+          $ref: "#/components/responses/Error"
+        "409":
+          $ref: "#/components/responses/Error"
+  /v1/setup_intents/{setupIntentId}:
+    parameters:
+      - name: setupIntentId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: setup_intent
+            missing: fseti_00000000000000000000000000
+    get:
+      operationId: GetSetupIntent
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: expand
+          in: query
+          required: false
+          description: Comma-separated fields to expand (customer, payment_method).
+          schema:
+            type: string
+            enum: ["customer", "payment_method", "customer,payment_method"]
+      responses:
+        "200":
+          description: The setup intent
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SetupIntentEnvelope"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /v1/subscriptions/{subscriptionId}:
+    parameters:
+      - name: subscriptionId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: subscription
+            missing: fsub_00000000000000000000000000
+    get:
+      operationId: GetSubscription
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: >-
+            The subscription a completed subscription-mode checkout session created.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SubscriptionEnvelope"
+        "401":
+          $ref: "#/components/responses/Error"
+        "404":
+          $ref: "#/components/responses/Error"
+  /pay/{sessionId}:
+    parameters:
+      - name: sessionId
+        in: path
+        required: true
+        schema:
+          type: string
+    get:
+      operationId: HostedCheckoutPage
+      security: []
+      x-emulates:
+        supported: true
+        parity:
+          enabled: false
+          safe: true
+          reason: A browser-facing HTML page; covered by the acceptance suite, not by JSON walks.
+      responses:
+        "200":
+          description: The card form (or the letter-of-medical-necessity step)
+          content:
+            text/html:
+              schema:
+                type: string
+        "404":
+          description: Unknown session
+          content:
+            text/html:
+              schema:
+                type: string
+        "409":
+          description: The session is no longer payable
+          content:
+            text/html:
+              schema:
+                type: string
+    post:
+      operationId: SubmitHostedCheckout
+      security: []
+      x-emulates:
+        supported: true
+        parity:
+          enabled: false
+          safe: false
+          reason: A browser form post; covered by the acceptance suite.
+      requestBody:
+        required: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                step:
+                  type: string
+                  enum: [card, lmn]
+                cardNumber:
+                  type: string
+                expiry:
+                  type: string
+                cvc:
+                  type: string
+                postalCode:
+                  type: string
+                email:
+                  type: string
+                firstName:
+                  type: string
+                lastName:
+                  type: string
+                phone:
+                  type: string
+      responses:
+        "302":
+          description: Paid; redirects to success_url (or to the next action's page)
+        "400":
+          description: The card form is incomplete or the card number is invalid
+          content:
+            text/html:
+              schema:
+                type: string
+        "402":
+          description: The card was declined
+          content:
+            text/html:
+              schema:
+                type: string
+        "404":
+          description: Unknown session
+          content:
+            text/html:
+              schema:
+                type: string
+        "409":
+          description: The session is no longer payable
+          content:
+            text/html:
+              schema:
+                type: string
+  /pay/{sessionId}/cancel:
+    parameters:
+      - name: sessionId
+        in: path
+        required: true
+        schema:
+          type: string
+    get:
+      operationId: CancelHostedCheckout
+      security: []
+      x-emulates:
+        supported: true
+        parity:
+          enabled: false
+          safe: true
+          reason: A browser navigation to cancel_url; covered by the acceptance suite.
+      responses:
+        "302":
+          description: Redirects to cancel_url; the session stays open
+        "404":
+          description: Unknown session
+          content:
+            text/html:
+              schema:
+                type: string
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      description: A secret key, `fsk_test_…` (test mode) or `fsk_…` (live mode).
+  responses:
+    Error:
+      description: An error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorBody"
+  schemas:
+    ErrorBody:
+      type: object
+      required: [error]
+      properties:
+        error:
+          type: object
+          required: [type, message]
+          properties:
+            type:
+              type: string
+              enum:
+                - invalid_request_error
+                - authentication_error
+                - idempotency_error
+                - api_error
+                - card_error
+            code:
+              type: string
+            message:
+              type: string
+            param:
+              type: string
+    StringMap:
+      type: object
+      maxProperties: 50
+      additionalProperties:
+        type: string
+        maxLength: 500
+    Product:
+      type: object
+      required: [product_id, name, active, test_mode, created_at]
+      properties:
+        product_id:
+          type: string
+          x-emulates-resource:
+            type: product
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        name:
+          type: string
+        description:
+          type: ["string", "null"]
+        url:
+          type: ["string", "null"]
+        client_reference_id:
+          type: ["string", "null"]
+        hsa_fsa_eligibility:
+          description: >-
+            not_eligible, auto_substantiation, private_label, letter_of_medical_necessity,
+            prescription, vision or service; null until Flex classifies a new product.
+          type: ["string", "null"]
+        visit_type:
+          type: ["string", "null"]
+        active:
+          type: boolean
+        test_mode:
+          type: boolean
+        metadata:
+          type: ["object", "null"]
+          additionalProperties:
+            type: string
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    ProductEnvelope:
+      type: object
+      required: [product]
+      properties:
+        product:
+          $ref: "#/components/schemas/Product"
+    ProductList:
+      type: object
+      required: [products, has_more]
+      properties:
+        products:
+          type: array
+          items:
+            $ref: "#/components/schemas/Product"
+        has_more:
+          type: boolean
+    CreateProductBody:
+      type: object
+      required: [product]
+      properties:
+        product:
+          type: object
+          required: [name]
+          properties:
+            name:
+              type: string
+              minLength: 1
+              maxLength: 250
+            description:
+              type: string
+              maxLength: 1000
+            url:
+              type: string
+              maxLength: 2048
+            client_reference_id:
+              type: string
+              minLength: 1
+              maxLength: 255
+            metadata:
+              $ref: "#/components/schemas/StringMap"
+    UpdateProductBody:
+      type: object
+      required: [product]
+      properties:
+        product:
+          type: object
+          properties:
+            active:
+              type: boolean
+            name:
+              type: string
+              minLength: 1
+              maxLength: 250
+            description:
+              type: string
+              maxLength: 1000
+            url:
+              type: string
+              maxLength: 2048
+            metadata:
+              $ref: "#/components/schemas/StringMap"
+    LineItem:
+      type: object
+      required: [price_data, quantity]
+      properties:
+        price_data:
+          type: object
+          required: [product, unit_amount]
+          properties:
+            product:
+              type: string
+              x-emulates-resource-ref:
+                type: product
+                missing: fprod_00000000000000000000000000
+            unit_amount:
+              type: integer
+              minimum: 0
+              maximum: 10000000
+            recurring:
+              $ref: "#/components/schemas/Recurring"
+        quantity:
+          type: integer
+          minimum: 1
+          maximum: 100
+    Recurring:
+      type: object
+      description: >-
+        Makes the line item's price recurring; a subscription-mode session needs at least one.
+      required: [interval]
+      properties:
+        interval:
+          type: string
+          enum: [day, week, month, year]
+        interval_count:
+          type: integer
+          minimum: 1
+          maximum: 12
+    SubscriptionData:
+      type: object
+      properties:
+        cancel_at_period_end:
+          type: boolean
+        metadata:
+          $ref: "#/components/schemas/StringMap"
+    CreateCheckoutSessionBody:
+      type: object
+      required: [checkout_session]
+      properties:
+        checkout_session:
+          type: object
+          required: [success_url, line_items]
+          properties:
+            allow_promotion_codes:
+              type: boolean
+            capture_method:
+              type: string
+              enum: [automatic]
+            cancel_url:
+              type: string
+              minLength: 1
+              maxLength: 2048
+            success_url:
+              type: string
+              minLength: 1
+              maxLength: 2048
+            client_reference_id:
+              type: string
+              minLength: 1
+              maxLength: 255
+            line_items:
+              type: array
+              maxItems: 20
+              items:
+                $ref: "#/components/schemas/LineItem"
+            metadata:
+              $ref: "#/components/schemas/StringMap"
+            mode:
+              type: string
+              enum: [payment, subscription, off_session, setup]
+            subscription_data:
+              $ref: "#/components/schemas/SubscriptionData"
+            payment_method:
+              type: string
+              maxLength: 255
+            customer:
+              type: string
+              x-emulates-resource-ref:
+                type: customer
+                missing: fcus_00000000000000000000000000
+            setup_future_use:
+              type: string
+              enum: [off_session]
+    RefundCheckoutSessionBody:
+      type: object
+      required: [checkout_session]
+      properties:
+        checkout_session:
+          type: object
+          properties:
+            amount:
+              type: integer
+              minimum: 1
+              maximum: 10000000
+    CreateCustomerBody:
+      type: object
+      required: [customer]
+      properties:
+        customer:
+          type: object
+          required: [first_name, last_name, email, phone]
+          properties:
+            first_name:
+              type: string
+              minLength: 1
+              maxLength: 100
+            last_name:
+              type: string
+              minLength: 1
+              maxLength: 100
+            email:
+              type: string
+              format: email
+              maxLength: 254
+            phone:
+              type: string
+              minLength: 1
+              maxLength: 32
+    Customer:
+      type: object
+      required: [customer_id, test_mode, created_at]
+      properties:
+        customer_id:
+          type: string
+          x-emulates-resource:
+            type: customer
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        first_name:
+          type: ["string", "null"]
+        last_name:
+          type: ["string", "null"]
+        email:
+          type: ["string", "null"]
+        phone:
+          type: ["string", "null"]
+        test_mode:
+          type: boolean
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    CustomerEnvelope:
+      type: object
+      required: [customer]
+      properties:
+        customer:
+          $ref: "#/components/schemas/Customer"
+    PaymentMethod:
+      type: object
+      required: [payment_method_id, type]
+      properties:
+        payment_method_id:
+          type: string
+          x-emulates-volatile:
+            kind: id
+        type:
+          type: string
+          enum: [card]
+        hsa_fsa:
+          type: boolean
+        customer:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+    PaymentIntent:
+      type: object
+      required: [payment_intent_id, amount, status]
+      properties:
+        payment_intent_id:
+          type: string
+          x-emulates-volatile:
+            kind: id
+        amount:
+          type: integer
+        amount_received:
+          type: ["integer", "null"]
+        customer:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+        payment_method:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+        status:
+          type: string
+          enum:
+            - requires_payment_method
+            - requires_action
+            - processing
+            - succeeded
+            - canceled
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    SetupIntent:
+      type: object
+      required: [setup_intent_id, status]
+      properties:
+        setup_intent_id:
+          type: string
+          x-emulates-volatile:
+            kind: id
+        status:
+          type: string
+          enum: [requires_payment_method, requires_action, processing, succeeded, canceled]
+        customer:
+          anyOf:
+            - type: string
+            - $ref: "#/components/schemas/Customer"
+            - type: "null"
+        payment_method:
+          anyOf:
+            - type: string
+            - $ref: "#/components/schemas/PaymentMethod"
+            - type: "null"
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    SetupIntentEnvelope:
+      type: object
+      required: [setup_intent]
+      properties:
+        setup_intent:
+          $ref: "#/components/schemas/SetupIntent"
+    NextAction:
+      type: object
+      required: [type]
+      properties:
+        type:
+          type: string
+          enum:
+            - collect_letter_of_medical_necessity
+            - provide_second_payment_method
+            - provide_alternative_payment_method
+            - payment_failed
+        collect_letter_of_medical_necessity:
+          type: object
+          required: [url]
+          properties:
+            url:
+              type: string
+              x-emulates-volatile:
+                kind: url
+        provide_second_payment_method:
+          type: object
+          required: [url]
+          properties:
+            url:
+              type: string
+              x-emulates-volatile:
+                kind: url
+        provide_alternative_payment_method:
+          type: object
+          required: [url]
+          properties:
+            url:
+              type: string
+              x-emulates-volatile:
+                kind: url
+        payment_failed:
+          type: object
+    ResponseLineItem:
+      type: object
+      required: [price_data, quantity, amount_total]
+      properties:
+        price_data:
+          type: object
+          required: [product, unit_amount]
+          properties:
+            product:
+              type: string
+              x-emulates-volatile:
+                kind: id
+            unit_amount:
+              type: integer
+            recurring:
+              anyOf:
+                - $ref: "#/components/schemas/Recurring"
+                - type: "null"
+        quantity:
+          type: integer
+        amount_total:
+          type: integer
+    CheckoutSession:
+      type: object
+      required:
+        - checkout_session_id
+        - amount_total
+        - status
+        - mode
+        - redirect_url
+        - url
+        - test_mode
+        - created_at
+      properties:
+        checkout_session_id:
+          type: string
+          x-emulates-resource:
+            type: checkout_session
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        client_reference_id:
+          type: ["string", "null"]
+        amount_total:
+          type: integer
+          minimum: 0
+        amount_received:
+          type: ["integer", "null"]
+        amount_refunded:
+          type: integer
+          minimum: 0
+        customer:
+          anyOf:
+            - type: string
+              x-emulates-volatile:
+                kind: id
+            - $ref: "#/components/schemas/Customer"
+            - type: "null"
+        payment_intent:
+          anyOf:
+            - type: string
+              x-emulates-volatile:
+                kind: id
+            - $ref: "#/components/schemas/PaymentIntent"
+            - type: "null"
+        setup_intent:
+          type: ["string", "null"]
+          x-emulates-resource:
+            type: setup_intent
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        mode:
+          type: string
+          enum: [payment, subscription, off_session, setup]
+        subscription:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+        subscription_data:
+          anyOf:
+            - $ref: "#/components/schemas/SubscriptionData"
+            - type: "null"
+        status:
+          type: string
+          enum: [open, paid, complete, canceled, expired]
+        redirect_url:
+          type: string
+          x-emulates-volatile:
+            kind: url
+        url:
+          type: string
+          x-emulates-volatile:
+            kind: url
+        success_url:
+          type: string
+        cancel_url:
+          type: ["string", "null"]
+        next_action:
+          anyOf:
+            - $ref: "#/components/schemas/NextAction"
+            - type: "null"
+        visit_type:
+          type: ["string", "null"]
+        metadata:
+          type: ["object", "null"]
+          additionalProperties:
+            type: string
+        line_items:
+          type: array
+          items:
+            $ref: "#/components/schemas/ResponseLineItem"
+        allow_promotion_codes:
+          type: boolean
+        capture_method:
+          type: string
+        setup_future_use:
+          type: ["string", "null"]
+        test_mode:
+          type: boolean
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+        expires_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    CheckoutSessionEnvelope:
+      type: object
+      required: [checkout_session]
+      properties:
+        checkout_session:
+          $ref: "#/components/schemas/CheckoutSession"
+    CheckoutSessionList:
+      type: object
+      required: [checkout_sessions, has_more]
+      properties:
+        checkout_sessions:
+          type: array
+          items:
+            $ref: "#/components/schemas/CheckoutSession"
+        has_more:
+          type: boolean
+    SubscriptionItem:
+      type: object
+      required: [price_data, quantity]
+      properties:
+        price_data:
+          type: object
+          required: [product, unit_amount, recurring]
+          properties:
+            product:
+              type: string
+              x-emulates-volatile:
+                kind: id
+            unit_amount:
+              type: integer
+            recurring:
+              $ref: "#/components/schemas/Recurring"
+        quantity:
+          type: integer
+    Subscription:
+      type: object
+      required: [subscription_id, created_at, items, status, cancel_at_period_end, test_mode]
+      properties:
+        subscription_id:
+          type: string
+          x-emulates-resource:
+            type: subscription
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        status:
+          type: string
+          enum:
+            - incomplete
+            - incomplete_expired
+            - trialing
+            - active
+            - past_due
+            - canceled
+            - unpaid
+            - paused
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/SubscriptionItem"
+        customer:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+        default_payment_method:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: id
+        cancel_at_period_end:
+          type: boolean
+        current_period_start:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+        current_period_end:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+        canceled_at:
+          type: ["string", "null"]
+        metadata:
+          type: ["object", "null"]
+          additionalProperties:
+            type: string
+        test_mode:
+          type: boolean
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    SubscriptionEnvelope:
+      type: object
+      required: [subscription]
+      properties:
+        subscription:
+          $ref: "#/components/schemas/Subscription"