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

# Show membership settings

> Show the authenticated creditor company's current membership, available plan changes, billing payment method summary, account usage, configured rates, and over-limit status.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /membership-settings
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /membership-settings:
    get:
      tags:
        - Membership Settings
      summary: Show membership settings
      description: >-
        Show the authenticated creditor company's current membership, available
        plan changes, billing payment method summary, account usage, configured
        rates, and over-limit status.
      operationId: creditorShowMembershipSettings
      responses:
        '200':
          description: Membership settings returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipSettingsDashboardResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    MembershipSettingsDashboardResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - current_company_membership
            - current_membership
            - plans
            - account_usage
            - rates
            - flags
          properties:
            current_company_membership:
              $ref: '#/components/schemas/CompanyMembership'
            current_membership:
              $ref: '#/components/schemas/MembershipSettingsPlan'
            plans:
              type: array
              items:
                $ref: '#/components/schemas/MembershipSettingsPlan'
            display_cards:
              type: array
              description: >-
                Legacy-compatible ordered card list. Upgrade memberships appear
                first, then the enterprise inquiry card when available, then
                available and blocked downgrade plans.
              items:
                $ref: '#/components/schemas/MembershipSettingsDisplayCard'
            latest_membership_transaction:
              anyOf:
                - $ref: '#/components/schemas/MembershipTransaction'
                - type: 'null'
            latest_over_limit_transaction:
              anyOf:
                - $ref: '#/components/schemas/OverLimitTransaction'
                - type: 'null'
            latest_membership_inquiry:
              anyOf:
                - $ref: '#/components/schemas/MembershipInquiry'
                - type: 'null'
            payment_profile:
              anyOf:
                - $ref: '#/components/schemas/MembershipPaymentProfile'
                - type: 'null'
            account_usage:
              $ref: '#/components/schemas/MembershipSettingsAccountUsage'
            rates:
              $ref: '#/components/schemas/MembershipSettingsRates'
            flags:
              $ref: '#/components/schemas/MembershipSettingsFlags'
            membership_inquiry_card:
              $ref: '#/components/schemas/MembershipInquiryCard'
        meta:
          type: object
          properties:
            options:
              type: object
              properties:
                payment_methods:
                  type: array
                  items:
                    $ref: '#/components/schemas/Option'
                account_types:
                  type: array
                  items:
                    $ref: '#/components/schemas/Option'
    CompanyMembership:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
        membership_id:
          type: integer
        next_membership_plan_id:
          type: integer
          nullable: true
        status:
          type: string
          nullable: true
        current_plan_start:
          type: string
          format: date-time
          nullable: true
        current_plan_end:
          type: string
          format: date-time
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          nullable: true
        membership:
          anyOf:
            - $ref: '#/components/schemas/CreditorMembership'
            - type: 'null'
        next_membership_plan:
          anyOf:
            - $ref: '#/components/schemas/CreditorMembership'
            - type: 'null'
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MembershipSettingsPlan:
      allOf:
        - $ref: '#/components/schemas/CreditorMembership'
        - type: object
          properties:
            price_per_day:
              type: number
              format: float
            tier_score:
              type: number
              format: float
            is_current:
              type: boolean
            is_upgrade:
              type: boolean
            is_downgrade:
              type: boolean
            is_blocked_by_account_limit:
              type: boolean
            new_plan_amount:
              type: number
              format: float
              nullable: true
            new_plan_end:
              type: string
              format: date-time
              nullable: true
            account_limit_exceeded_message:
              type: string
              nullable: true
    MembershipSettingsDisplayCard:
      oneOf:
        - type: object
          required:
            - type
            - membership
          properties:
            type:
              type: string
              enum:
                - membership
            membership:
              $ref: '#/components/schemas/MembershipSettingsPlan'
        - type: object
          required:
            - type
            - membership_inquiry_card
          properties:
            type:
              type: string
              enum:
                - enterprise
            membership_inquiry_card:
              $ref: '#/components/schemas/MembershipInquiryCard'
    MembershipTransaction:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
        membership_id:
          type: integer
        status:
          type: string
        price:
          type: number
          format: float
        tilled_transaction_id:
          type: string
          nullable: true
        plan_end_date:
          type: string
          format: date-time
          nullable: true
        partner_revenue_share:
          type: integer
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    OverLimitTransaction:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
        subscription_id:
          type: integer
          nullable: true
        type:
          type: string
          nullable: true
        accounts_over_limit:
          type: integer
        price_per_account:
          type: number
          format: float
        total_amount:
          type: number
          format: float
        status:
          type: string
        tilled_transaction_id:
          type: string
          nullable: true
        billing_period_start:
          type: string
          format: date
          nullable: true
        billing_period_end:
          type: string
          format: date
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MembershipInquiry:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        description:
          type: string
          nullable: true
        accounts_in_scope:
          type: integer
        status:
          type: integer
          enum:
            - 0
            - 1
            - 2
          description: 0 is New Inquiry, 1 is Plan Created, and 2 is Closed/No Deal.
        status_label:
          type: string
          example: New Inquiry
        has_special_membership:
          type: boolean
        company:
          $ref: '#/components/schemas/MembershipInquiryCompany'
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MembershipPaymentProfile:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
        first_name:
          type: string
        last_name:
          type: string
        last_four_digit:
          type: string
          nullable: true
        expiry:
          type: string
          nullable: true
        payment_method:
          type: string
          nullable: true
        account_type:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MembershipSettingsAccountUsage:
      type: object
      properties:
        active_accounts:
          type: integer
        upload_accounts_limit:
          type: integer
        remaining_accounts:
          type: integer
        accounts_over_limit:
          type: integer
        estimated_over_limit_charge:
          type: number
          format: float
    MembershipSettingsRates:
      type: object
      properties:
        sms_rate:
          type: number
          format: float
        email_rate:
          type: number
          format: float
        over_limit_price_per_account:
          type: number
          format: float
    MembershipSettingsFlags:
      type: object
      properties:
        is_last_transaction_failed:
          type: boolean
        is_last_over_limit_transaction_failed:
          type: boolean
        enterprise_card_available:
          type: boolean
    MembershipInquiryCard:
      type: object
      properties:
        available:
          type: boolean
          description: Whether the special-plan inquiry/contact card should be shown.
        has_pending_inquiry:
          type: boolean
          description: Whether the company already has a pending special-plan inquiry.
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp for the pending inquiry, when one exists.
        contact_email:
          type: string
          format: email
          example: help@younegotiate.com
        contact_phone:
          type: string
          example: '+13212000010'
    Option:
      type: object
      additionalProperties: true
      properties:
        value:
          oneOf:
            - type: string
            - type: integer
        label:
          type: string
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    CreditorMembership:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
          nullable: true
        name:
          type: string
        price:
          type: number
          format: float
        fee:
          type: number
          format: float
        e_letter_fee:
          type: number
          format: float
        upload_accounts_limit:
          type: integer
          nullable: true
        frequency:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        features:
          nullable: true
        status:
          type: boolean
        position:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MembershipInquiryCompany:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_name:
          type: string
        owner_full_name:
          type: string
          nullable: true
        owner_email:
          type: string
          format: email
          nullable: true
        owner_phone:
          type: string
          nullable: true
        company_phone:
          type: string
          nullable: true
        special_membership:
          anyOf:
            - $ref: '#/components/schemas/CreditorMembership'
            - type: 'null'
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````