Rentberry Rental Subscription API

openapi: 3.2.0
info:
  title: Rentberry Rental Subscription API
  description: Renting Done Right. Finally.
  version: 4
tags:
- name: Rental Subscription
  description: Rental Subscription
paths:
  /v{version}/rental/{rental_id}/subscription/stripe:
    post:
      tags:
      - Rental Subscription
      summary: Create a rental subscription with Stripe.
      description: Creates a new rental subscription and returns client secret for Stripe payment setup. Available since API version 4.
      operationId: post_api_v4_rental_subscription_stripe
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      - name: rental_id
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RentalPaymentType'
      responses:
        '200':
          description: Subscription created successfully with client secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeSubscriptionCreatedResponse'
        '400':
          description: Validation failed.
        '401':
          description: Unauthorized
        '403':
          description: Access denied to rental.
      security:
      - XAuthToken: []
  /v{version}/rental/subscription/{rental_subscription_id}/stripe/update:
    post:
      tags:
      - Rental Subscription
      summary: Update an existing rental subscription.
      description: Updates rental subscription payment details. Available since API version 4.
      operationId: post_api_v4_rental_subscription_stripe_update
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      - name: rental_subscription_id
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RentalPaymentType'
      responses:
        '200':
          description: Subscription updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeSubscriptionCreatedResponse'
        '400':
          description: Validation failed.
        '401':
          description: Unauthorized
        '403':
          description: Access denied to subscription.
      security:
      - XAuthToken: []
  /v{version}/rental/subscription/{rental_subscription_id}/stripe:
    get:
      tags:
      - Rental Subscription
      summary: Get rental subscription details.
      description: Retrieves details of a specific rental subscription. Available since API version 4.
      operationId: get_api_v4_rental_subscription_stripe_get
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      - name: rental_subscription_id
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      responses:
        '200':
          description: Subscription details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeSubscriptionCreatedResponse'
        '401':
          description: Unauthorized
        '403':
          description: Access denied to subscription.
        '404':
          description: Subscription not found.
      security:
      - XAuthToken: []
    delete:
      tags:
      - Rental Subscription
      summary: Cancel a rental subscription.
      description: Cancels an active rental subscription. Available since API version 4.
      operationId: delete_api_v4_rental_subscription_stripe_cancel
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      - name: rental_subscription_id
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      responses:
        '204':
          description: Subscription cancelled successfully.
        '401':
          description: Unauthorized
        '403':
          description: Access denied to subscription.
        '404':
          description: Subscription not found.
      security:
      - XAuthToken: []
components:
  schemas:
    RentalPaymentType:
      required:
      - comment
      - amount
      - paymentMethod
      properties:
        comment:
          type: string
        amount:
          type: number
        paymentMethod:
          type: string
      type: object
    StripeSubscriptionCreatedResponse:
      properties:
        clientSecret:
          type: string
        rentalSubscriptionId:
          type: integer
        amount:
          type: string
        amountTotal:
          type: string
        commissionFee:
          type: string
        status:
          type: string
        currency:
          type: string
        paymentMethod:
          type: string
        stripeSubscriptionId:
          type: string
      type: object