> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vellaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause My Subscription



## OpenAPI

````yaml https://api.vellaro.io/openapi/storefront.json post /api/v1/account/subscriptions/{sub_id}/pause
openapi: 3.1.0
info:
  title: Vellaro Storefront API
  description: >-
    The API of storefronts and mobile apps. The store comes from the publishable
    key in the `X-Vellaro-Key` header (or from the store's domain); the
    customer's endpoints also take the customer's token as `Authorization:
    Bearer <access_token>`.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Authentication
    description: >-
      Customer sign-up and login, tokens, password reset, email verification,
      Google and Apple login, two-factor authentication.
  - name: Catalog
    description: Products, categories and brands, with filters, sorting and pagination.
  - name: Search
    description: Full-text product search and suggestions as you type.
  - name: Cart
    description: >-
      The cart of a guest (`X-Cart-Token`) or of the logged-in customer, and the
      extra warranty offered on a product page.
  - name: Checkout & orders
    description: >-
      Checkout, the customer's orders and reorder, «Order on WhatsApp» (cart
      codes, clicks).
  - name: Payments
    description: >-
      The store's payment methods, paying an order again, and the confirmation
      steps of PayPal, PokPay and Iute.
  - name: Account
    description: >-
      The logged-in customer: profile, addresses, wishlist, digital downloads,
      subscriptions, affiliate account.
  - name: Reviews & questions
    description: Product reviews and product questions.
  - name: AI chat
    description: 'The store''s AI shopping assistant: conversations, messages, feedback.'
  - name: Content
    description: CMS pages, menus, banners, flipbooks and information pages.
  - name: Marketing & contact
    description: >-
      Newsletter sign-up and email links, the contact form, campaign click
      tracking.
  - name: Store
    description: >-
      The store for the storefront: brand, public settings, languages,
      translations, currencies, physical stores, theme.
  - name: Devices
    description: Push-notification devices of the mobile app.
paths:
  /api/v1/account/subscriptions/{sub_id}/pause:
    post:
      tags:
        - Account
      summary: Pause My Subscription
      operationId: pause_my_subscription_api_v1_account_subscriptions__sub_id__pause_post
      parameters:
        - name: sub_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Sub Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_SubscriptionOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_SubscriptionOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/SubscriptionOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[SubscriptionOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SubscriptionOut:
      properties:
        id:
          type: string
          title: Id
        product_id:
          type: string
          title: Product Id
        recurring_id:
          type: string
          title: Recurring Id
        recurring_name:
          type: string
          title: Recurring Name
        recurring_frequency:
          type: string
          title: Recurring Frequency
        recurring_price:
          type: number
          title: Recurring Price
        status:
          type: string
          title: Status
        quantity:
          type: integer
          title: Quantity
        next_billing_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Billing Date
        current_period_end:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Current Period End
        last_charged_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Charged At
        failed_attempts:
          type: integer
          title: Failed Attempts
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
        canceled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Canceled At
        paused_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Paused At
        order_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Order Id
        customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Id
        customer_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Email
        customer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Name
        product_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Product Name
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        billing_interval:
          type: integer
          title: Billing Interval
          default: 1
        charges_made:
          anyOf:
            - type: integer
            - type: 'null'
          title: Charges Made
        charges_total:
          type: integer
          title: Charges Total
          default: 0
      type: object
      required:
        - id
        - product_id
        - recurring_id
        - recurring_name
        - recurring_frequency
        - recurring_price
        - status
        - quantity
        - created_at
      title: SubscriptionOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.