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

# Find Proposals

> Search proposals with given parameters



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/quotes/find
openapi: 3.1.0
info:
  title: Measure API
  description: APIs to communicate with Measure
  version: 1.0.0
servers:
  - url: https://api.getmeasure.com/api/v1
security: []
paths:
  /companies/{company_id}/quotes/find:
    post:
      tags:
        - Proposals
      summary: Find Proposals
      description: Search proposals with given parameters
      operationId: Find_Proposals
      parameters:
        - name: company_id
          in: path
          description: 'The company ID with the prefix ''cmp_''. '
          required: true
          schema:
            description: 'The company ID with the prefix ''cmp_''. '
            type: string
        - name: Idempotency-Key
          in: header
          description: >-
            The idempotency key that will be used to ensure the request is only
            performed once
          schema:
            description: >-
              The idempotency key that will be used to ensure the request is
              only performed once
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFindQuoteRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFindQuoteResponse'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestFindQuoteRequest:
      properties:
        include_meta:
          description: >-
            Whether to include additional metadata in the pagination response
            such the number of total results
          type:
            - 'null'
            - boolean
        pagination:
          $ref: '#/components/schemas/RequestPaginationRequest'
          description: The pagination parameters for the request
        query:
          $ref: '#/components/schemas/RequestFindQuoteQueryCriteria'
          description: The query criteria for the request
        sort_key:
          default: createdAtDesc
          enum:
            - createdAtDesc
            - createdAtAsc
            - updatedAtAsc
            - updatedAtDesc
          type: string
      required:
        - sort_key
        - pagination
      type: object
    ResponseFindQuoteResponse:
      properties:
        pagination:
          $ref: '#/components/schemas/ResponsePaginationResponse'
        results:
          items:
            $ref: '#/components/schemas/ResponseProposalLiteRepresentation'
          type:
            - array
            - 'null'
      type: object
    RequestPaginationRequest:
      description: The pagination parameters for the request
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          default: 20
          format: int64
          maximum: 200
          minimum: 0
          type: integer
      type: object
    RequestFindQuoteQueryCriteria:
      properties:
        customer_id:
          type:
            - 'null'
            - string
        owner_id:
          type:
            - 'null'
            - string
        search:
          type:
            - 'null'
            - string
        statuses:
          enum:
            - QUOTE_DRAFT
            - QUOTE_ACCEPT
            - QUOTE_NEEDS_APPROVAL
            - QUOTE_PENDING_PAYMENT
            - QUOTE_EXECUTED
            - QUOTE_PENDING_SELECTION
            - QUOTE_DECLINED
            - QUOTE_REJECTED
          items:
            type: string
          type:
            - array
            - 'null'
        type:
          enum:
            - QUOTE
          type:
            - string
      required:
        - type
      type:
        - object
        - 'null'
    ResponsePaginationResponse:
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          format: int64
          type: integer
      type: object
    ResponseProposalLiteRepresentation:
      properties:
        acv:
          $ref: '#/components/schemas/ModelAmount'
        auto_charges:
          type: boolean
        auto_renews:
          type: boolean
        bundle_pricing_id:
          type: string
        change_custom_date:
          format: date-time
          type:
            - 'null'
            - string
        change_proration_type:
          type:
            - 'null'
            - string
        change_reset_billing_anchor:
          type:
            - 'null'
            - boolean
        change_timing:
          type:
            - 'null'
            - string
        company_id:
          type: string
        completed_date:
          format: date-time
          type:
            - 'null'
            - string
        config_items:
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type:
            - array
            - 'null'
        contract_attachments:
          items:
            $ref: '#/components/schemas/ResponseContractAttachmentRepresentation'
          type:
            - array
            - 'null'
        counter_signatories:
          items:
            $ref: '#/components/schemas/ResponseCounterSignatoryRepresentation'
          type:
            - array
            - 'null'
        created_at:
          format: date-time
          type: string
        custom_variables:
          additionalProperties: {}
          type:
            - object
            - 'null'
        customer_email:
          type:
            - 'null'
            - string
        customer_id:
          type:
            - 'null'
            - string
        customer_name:
          type:
            - 'null'
            - string
        description:
          type:
            - 'null'
            - string
        discounts:
          items:
            $ref: '#/components/schemas/ModelDiscount'
          type:
            - array
            - 'null'
        expiration_date:
          format: date-time
          type:
            - 'null'
            - string
        finalized_date:
          format: date-time
          type:
            - 'null'
            - string
        follow_up:
          type:
            - 'null'
            - string
        follow_up_data:
          additionalProperties: true
          type: object
        id:
          type: string
        invoice_due_date_from_creation:
          minimum: 0
          type:
            - 'null'
            - integer
        invoice_event_grace_period:
          minimum: 0
          type:
            - 'null'
            - integer
        metadata:
          additionalProperties: true
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
        one_time_billables:
          items:
            $ref: '#/components/schemas/ResponseOneTimeRepresentation'
          type:
            - array
            - 'null'
        options:
          $ref: '#/components/schemas/ModelProposalOptions'
        owner_id:
          type:
            - 'null'
            - string
        parent_billed:
          type: boolean
        payment_provided_date:
          format: date-time
          type:
            - 'null'
            - string
        po_number:
          type:
            - 'null'
            - string
        proposal_link_id:
          type:
            - 'null'
            - string
        quote_plans:
          items:
            $ref: '#/components/schemas/ResponseQuotePlanRepresentation'
          type:
            - 'null'
            - array
        require_payment_method:
          type: boolean
        selected_plan_id:
          type:
            - 'null'
            - string
        signatories:
          items:
            $ref: '#/components/schemas/ModelSignatory'
          type:
            - array
            - 'null'
        signed_date:
          format: date-time
          type:
            - 'null'
            - string
        signed_file_id:
          type:
            - 'null'
            - string
        signed_offline:
          type: boolean
        start_date:
          format: date-time
          type:
            - 'null'
            - string
        start_type:
          type: string
        status:
          type: string
        tcv:
          $ref: '#/components/schemas/ModelAmount'
        template_variables:
          items:
            type: string
          type:
            - array
            - 'null'
        term:
          $ref: '#/components/schemas/ModelTerm'
        title:
          type: string
        trial:
          type: boolean
        trial_term:
          $ref: '#/components/schemas/ModelTerm'
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelAmount:
      description: The amount which has value in cents and a currency
      properties:
        currency:
          type: string
        value_in_cents:
          format: int64
          type: integer
      type: object
    ModelSubscriptionConfigItem:
      description: >-
        The configuration for pricing components which can be license counts or
        minimum usage units
      properties:
        hide_at_checkout:
          description: >-
            Whether the pricing row will be hidden at checkout, defaults to
            false
          type:
            - 'null'
            - boolean
        minimum_units:
          description: The number of minimum units for this usage-based component
          format: double
          minimum: 0
          type: number
        num_licenses:
          description: The number of licenses for this license-based component
          format: double
          minimum: 0
          type: number
        product_metric_pricing_id:
          description: The product metric pricing ID to which this config applies.
          type:
            - 'null'
            - string
        product_pricing_id:
          description: >-
            The product pricing ID to which this config applies. If the product
            pricing contains multiple components, the same config will apply to
            all of them
          type:
            - 'null'
            - string
        quantity_config:
          $ref: '#/components/schemas/ModelQuantityConfig'
        sort_order:
          description: The sort index
          type:
            - 'null'
            - number
        upsell_product_metric_pricing_id:
          type:
            - 'null'
            - string
      type: object
    ResponseContractAttachmentRepresentation:
      properties:
        attachment_type:
          type:
            - 'null'
            - string
        created_at:
          format: date-time
          type: string
        file_id:
          type: string
        id:
          type: string
        original_filename:
          type: string
        uploaded_at:
          format: date-time
          type: string
      type: object
    ResponseCounterSignatoryRepresentation:
      properties:
        company_user:
          $ref: '#/components/schemas/ResponseProposalCompanyUserRepresentation'
        declined:
          type: boolean
        email:
          type: string
        id:
          type: string
        position:
          type:
            - 'null'
            - integer
        signature_id:
          type:
            - 'null'
            - string
        signed:
          type: boolean
        signed_date:
          format: date-time
          type:
            - 'null'
            - string
      type: object
    ModelDiscount:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
        cap:
          $ref: '#/components/schemas/ModelAmount'
        company_id:
          type: string
        coupon_id:
          type:
            - 'null'
            - string
        created_at:
          format: date-time
          type: string
        customer_id:
          type:
            - 'null'
            - string
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        expiration_date:
          format: date-time
          type:
            - 'null'
            - string
        id:
          type: string
        import_created_at_ref:
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        item_pricing_id:
          type:
            - 'null'
            - string
        name:
          type: string
        onetime_billable:
          $ref: '#/components/schemas/ModelOneTimeBillable'
        onetime_billable_id:
          type:
            - 'null'
            - string
        percent:
          format: double
          type: number
        product_id:
          type:
            - 'null'
            - string
        product_pricing_id:
          type:
            - 'null'
            - string
        proposal_id:
          type:
            - 'null'
            - string
        state:
          type:
            - 'null'
            - string
        subscription_id:
          type:
            - 'null'
            - string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ResponseOneTimeRepresentation:
      properties:
        aggregate:
          format: double
          type: number
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        custom_price:
          $ref: '#/components/schemas/ModelOneTimeCustomPrice'
        customer_id:
          type:
            - 'null'
            - string
        id:
          type: string
        name:
          type: string
        product_pricing:
          $ref: '#/components/schemas/ResponseProductPricingRepresentation'
        product_pricing_id:
          type:
            - 'null'
            - string
        quantity_config:
          $ref: '#/components/schemas/ModelQuantityConfig'
        sort_order:
          type:
            - 'null'
            - number
        state:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelProposalOptions:
      properties:
        allow_promo_code:
          type: boolean
        collect_taxes:
          type: boolean
        completion_action:
          type: string
        confirmation_message:
          type: string
        redirect_url:
          type: string
        requires_customer_address:
          type: boolean
        requires_customer_confirmation:
          type: boolean
        requires_customer_phone:
          type: boolean
        requires_email_verification:
          type: boolean
        save_card_on_checkout:
          type: boolean
      type: object
    ResponseQuotePlanRepresentation:
      properties:
        auto_renews:
          type:
            - 'null'
            - boolean
        description:
          type:
            - 'null'
            - string
        display_name:
          type:
            - 'null'
            - string
        id:
          type: string
        is_recommended:
          type:
            - 'null'
            - boolean
        name:
          type: string
        order:
          type:
            - 'null'
            - string
        pricing_config:
          $ref: '#/components/schemas/ResponseQuotePlanPricingConfigRepresentation'
        term:
          $ref: '#/components/schemas/ModelTerm'
        trial:
          type:
            - 'null'
            - boolean
        trial_term:
          $ref: '#/components/schemas/ModelTerm'
      type: object
    ModelSignatory:
      properties:
        declined:
          type: boolean
        email:
          examples:
            - harry.potter@hogwarts.com
          format: email
          type: string
        name:
          type: string
        position:
          type:
            - 'null'
            - integer
        signature_id:
          type: string
        signature_link:
          type: string
        signed:
          type: boolean
        signed_date:
          format: date-time
          type:
            - 'null'
            - string
        title:
          type: string
        view_customer_input_timestamps:
          items:
            format: date-time
            type: string
          type: array
        view_timestamps:
          items:
            format: date-time
            type: string
          type: array
      required:
        - name
        - email
      type: object
    ModelTerm:
      description: >-
        The term which includes a frequency interval and a count for number of
        intervals
      properties:
        count:
          description: The number of times the frequency elapses
          exclusiveMinimum: 0
          format: int64
          type: integer
        frequency:
          description: The frequency at which the term repeats
          enum:
            - HOUR
            - DAY
            - WEEK
            - BI_MONTH
            - MONTH
            - QUARTER
            - BI_ANNUAL
            - YEAR
            - ONETIME
          type: string
      required:
        - frequency
        - count
      type: object
    ModelQuantityConfig:
      properties:
        allow_custom_quantity:
          type: boolean
        max_quantity:
          type: integer
        min_quantity:
          type: integer
      type: object
    ResponseProposalCompanyUserRepresentation:
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        image_url:
          type: string
        title:
          type: string
        updated_at:
          format: date-time
          type: string
        user:
          $ref: '#/components/schemas/ResponseProposalUserRepresentation'
      type: object
    GormDeletedAt:
      type: object
    ModelOneTimeBillable:
      properties:
        aggregate:
          format: double
          type: number
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        custom_price:
          $ref: '#/components/schemas/ModelOneTimeCustomPrice'
        customer_id:
          type:
            - 'null'
            - string
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        id:
          type: string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        name:
          type: string
        parent_billed:
          type: boolean
        product_pricing_id:
          type:
            - 'null'
            - string
        proposal_id:
          type:
            - 'null'
            - string
        quantity_config:
          $ref: '#/components/schemas/ModelQuantityConfig'
        sort_order:
          type:
            - 'null'
            - number
        state:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelOneTimeCustomPrice:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
          description: The amount of quantity
        description:
          description: The description of the one-time charge
          type:
            - string
            - 'null'
        product_id:
          description: The product ID
          type: string
      required:
        - product_id
        - amount
      type: object
    ResponseProductPricingRepresentation:
      properties:
        company_id:
          description: The company ID for the product pricing
          type: string
        computed_entitlements:
          description: The final computed features for the product pricing
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        created_at:
          description: The date the product pricing was created
          format: date-time
          type: string
        currency:
          description: The currency for the product pricing
          type:
            - string
            - 'null'
        description:
          description: The description for the product pricing
          type: string
        external_name:
          description: The externally exposed name for the product pricing used on invoices
          type: string
        id:
          description: The ID of the product pricing in Measure
          type: string
        import_created_at_ref:
          description: The date the product pricing was created from the import source
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          description: The import reference of the product pricing
          type:
            - 'null'
            - string
        imported_from:
          description: Where the product pricing was imported from
          type:
            - 'null'
            - string
        metadata:
          additionalProperties: true
          description: >-
            Any additional data as key-value pairs attached to the product
            pricing
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
          description: The minimum spend across the entire term of the product pricing
        name:
          description: The name of the product pricing
          type: string
        num_subs:
          description: The number of subscriptions in the company with the product pricing
          minimum: 0
          type: integer
        override_entitlements:
          description: The overridden features for the product pricing
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        product:
          $ref: '#/components/schemas/ResponseProductRepresentation'
          description: The expanded product for the product pricing
        product_id:
          description: The product ID that the product pricing is attached to
          type: string
        product_metric_pricings:
          description: The metric components of the product pricing plan
          items:
            $ref: '#/components/schemas/ResponseProductMetricPricingRepresentation'
          type:
            - array
            - 'null'
        state:
          description: The state of the product pricing such as ACTIVE or ARCHIVED
          type: string
        tags:
          description: Any tags on the product pricing
          items:
            type: string
          type:
            - array
            - 'null'
        type:
          description: The type of product pricing such as recurring or one-time
          type: string
        updated_at:
          description: The date the product pricing was last updated
          format: date-time
          type: string
        upsell_product_pricing_id:
          description: The upsell product pricing ID
          type:
            - 'null'
            - string
      type: object
    ResponseQuotePlanPricingConfigRepresentation:
      properties:
        all_product_pricings:
          items:
            $ref: '#/components/schemas/ResponseProductPricingRepresentation'
          type: array
        bundle_pricing:
          $ref: '#/components/schemas/ResponseBundlePricingRepresentation'
        bundle_pricing_id:
          type:
            - 'null'
            - string
        config_items:
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type: array
        currency:
          type:
            - string
            - 'null'
        discounts:
          items:
            $ref: '#/components/schemas/ModelDiscountParams'
          type: array
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
        one_time_billables:
          items:
            $ref: '#/components/schemas/ResponseOneTimeRepresentation'
          type: array
        onetime_items:
          items:
            $ref: '#/components/schemas/ModelOneTimeParams'
          type: array
        product_pricing_ids:
          items:
            type: string
          type: array
        scheduled_changes:
          items:
            $ref: >-
              #/components/schemas/ResponseSubscriptionChangeConfigRepresentation
          type: array
      type: object
    ResponseProposalUserRepresentation:
      properties:
        email:
          type: string
        id:
          type: string
        name:
          type: string
        verified:
          type: boolean
      type: object
    ResponseEntitlementDataRepresentation:
      properties:
        entitlement_id:
          type: string
        id:
          type: string
        inherited_from_id:
          type:
            - 'null'
            - string
        inherited_from_type:
          type:
            - 'null'
            - string
        key:
          type: string
        name:
          type: string
        original_value: {}
        overridden:
          type:
            - 'null'
            - boolean
        type:
          type: string
        value: {}
      type: object
    ResponseProductRepresentation:
      properties:
        company_id:
          description: The company ID of the product
          type: string
        created_at:
          description: The date the product was created
          format: date-time
          type: string
        description:
          description: The description of the product
          type: string
        entitlements:
          description: The entitlements that enable features for the product
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        external_name:
          description: The external name of the product
          type: string
        gl_code:
          description: The GL code for the product
          type:
            - 'null'
            - string
        id:
          description: The ID of the product in Measure
          type: string
        image_url:
          description: The url for the image of the product
          type:
            - 'null'
            - string
        import_created_at_ref:
          description: The date the product was created in the import source
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          description: The import reference ID for the product
          type:
            - 'null'
            - string
        imported_from:
          description: Where the product is imported from
          type:
            - 'null'
            - string
        metadata:
          additionalProperties: true
          description: Any additional data as key-value pairs attached to the product
          type: object
        name:
          description: The name of the product
          type: string
        num_subs:
          description: The number of subscriptions in the company with the product
          minimum: 0
          type: integer
        product_pricings:
          description: The product prices attached to this product
          items:
            $ref: '#/components/schemas/ResponseProductPricingRepresentation'
          type:
            - array
            - 'null'
        state:
          description: The state of the product such as ACTIVE or ARCHIVED
          type: string
        tags:
          description: Any tags on the product
          items:
            type: string
          type:
            - array
            - 'null'
        updated_at:
          description: The date the product was last updated
          format: date-time
          type: string
      type: object
    ResponseProductMetricPricingRepresentation:
      properties:
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        id:
          type: string
        item:
          $ref: '#/components/schemas/ResponseBillableItemRepresentation'
        item_id:
          type: string
        item_pricing:
          $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation'
        item_pricing_id:
          type: string
        metric:
          $ref: '#/components/schemas/ResponseBillableMetricStringRepresentation'
        metric_id:
          type: string
        product:
          $ref: '#/components/schemas/ResponseProductRepresentation'
        product_id:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ResponseBundlePricingRepresentation:
      properties:
        bundle_product_pricings:
          items:
            $ref: '#/components/schemas/ResponseBundleProductPricingRepresentation'
          type:
            - array
            - 'null'
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        currency:
          type:
            - string
            - 'null'
        description:
          type: string
        id:
          type: string
        is_auto_generated:
          type: boolean
        metadata:
          additionalProperties: true
          type: object
        name:
          type: string
        num_subs:
          minimum: 0
          type: integer
        state:
          type: string
        term:
          $ref: '#/components/schemas/ModelTerm'
        updated_at:
          format: date-time
          type: string
      type: object
    ModelDiscountParams:
      description: The details for the discount
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
        cap:
          $ref: '#/components/schemas/ModelAmount'
        coupon_id:
          type:
            - 'null'
            - string
        customer_id:
          type:
            - 'null'
            - string
        expiration_date:
          format: date-time
          type:
            - 'null'
            - string
        import_created_at_ref:
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        item_pricing_id:
          type:
            - 'null'
            - string
        name:
          type: string
        onetime_billable_id:
          type:
            - 'null'
            - string
        percent:
          format: double
          maximum: 1
          minimum: 0
          type: number
        product_id:
          type:
            - 'null'
            - string
        product_pricing_id:
          type:
            - 'null'
            - string
        proposal_id:
          type:
            - 'null'
            - string
        state:
          enum:
            - ACTIVE
            - PENDING
            - REVOKED
            - EXPIRED
            - CONSUMED
          type:
            - 'null'
            - string
        subscription_id:
          type:
            - 'null'
            - string
        type:
          enum:
            - DISCOUNT_AMOUNT
            - DISCOUNT_PERCENT
            - DISCOUNT_AMOUNT_PER_UNIT
          type: string
      required:
        - name
        - type
      type: object
    ModelOneTimeParams:
      description: The pricing and aggregate for the one-time billable item
      properties:
        aggregate:
          description: The quantity of the one-time charge
          exclusiveMinimum: 0
          format: double
          type: number
        custom_price:
          $ref: '#/components/schemas/ModelOneTimeCustomPrice'
          description: >-
            The custom pricing for the product. Either 'product_pricing_id' or
            'custom_price' is required
        product_pricing_id:
          description: >-
            The product pricing for the one-time charge. Either
            'product_pricing_id' or 'custom_price' is required
          type:
            - 'null'
            - string
        quantity_config:
          $ref: '#/components/schemas/ModelQuantityConfig'
        sort_order:
          description: The sort index
          type:
            - 'null'
            - number
      required:
        - aggregate
      type: object
    ResponseSubscriptionChangeConfigRepresentation:
      properties:
        actual_change_time:
          description: The actual change time of the subscription change
          format: date-time
          type:
            - 'null'
            - string
        all_product_pricings:
          description: >-
            All product pricings including those in ProductPricingIDs and
            OneTimeItems
          items:
            $ref: '#/components/schemas/ResponseProductPricingRepresentation'
          type: array
        auto_charges:
          description: Whether the subscription invoices are automatically charged
          type:
            - 'null'
            - boolean
        bundle_pricing:
          $ref: '#/components/schemas/ResponseBundlePricingRepresentation'
          description: The bundle pricing representing the plan selection for this change
        bundle_pricing_id:
          description: >-
            The bundle pricing id representing the plan selection for this
            change
          type:
            - 'null'
            - string
        config_items:
          description: Configuration items stored on the subscription at this stage
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type:
            - array
            - 'null'
        custom_change_date:
          description: >-
            The custom date of the subscription change if the change was a
            custom date change.
          format: date-time
          type:
            - 'null'
            - string
        discounts:
          description: Discount parameters stored on the subscription at this stage
          items:
            $ref: '#/components/schemas/ModelDiscountParams'
          type:
            - 'null'
            - array
        metadata:
          additionalProperties: true
          description: Metadata stored on the subscription at this stage
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
          description: The minimum spend of the subscription change
        onetime_items:
          description: One time items to be charged at this stage
          items:
            $ref: '#/components/schemas/ModelOneTimeParams'
          type:
            - array
            - 'null'
        payment_method_id:
          description: >-
            The payment method that should specifically be used to charge the
            invoices for this subscription
          type:
            - 'null'
            - string
        product_pricing_ids:
          description: >-
            The product pricing ids representing the plan selection for this
            change
          items:
            type: string
          type:
            - array
            - 'null'
        proration_type:
          description: How to prorate charges for the subscription change
          type:
            - string
            - 'null'
        relative_term:
          $ref: '#/components/schemas/ModelTerm'
          description: >-
            The relative term of the subscription change. Used if the timing is
            RELATIVE
        reset_billing_anchor:
          description: Whether to reset the billing anchor for the subscription change
          type:
            - 'null'
            - boolean
        term:
          $ref: '#/components/schemas/ModelTerm'
          description: The term of the subscription change
        timing:
          description: The timing of the subscription change
          type:
            - string
            - 'null'
        trial:
          description: Whether the subscription change is trial
          type:
            - 'null'
            - boolean
        trial_term:
          $ref: '#/components/schemas/ModelTerm'
          description: The trial term of the subscription change
      type: object
    ResponseBillableItemRepresentation:
      properties:
        company_id:
          description: The company ID for the billable item
          type: string
        created_at:
          description: The date the billable item was created
          format: date-time
          type: string
        description:
          description: Any description attached to the billable item
          type: string
        display_type:
          description: >-
            The display type of the billable item which can be one of UNITS,
            AMOUNT, THOUSAND_UNITS, MILLION_UNITS
          type: string
        editable:
          description: Whether the billable item can be further edited
          type: boolean
        external_name:
          description: The public name of the billable item
          type: string
        id:
          description: The ID of the billable item in Measure
          type: string
        name:
          description: The name of the billable item
          type: string
        standard:
          description: >-
            Whether this is a standard billable item in Measure or a custom
            billable item
          type: boolean
        type:
          description: >-
            The type of the billable item which can be one of CUSTOM_USAGE or
            CUSTOM_OBJ, based on usage-based item or object-based item
          type: string
        updated_at:
          description: The date the billable item was last updated
          format: date-time
          type: string
      type: object
    ResponseBillableItemPricingRepresentation:
      properties:
        base_price:
          $ref: '#/components/schemas/ModelAmount'
        base_units:
          format: double
          type: number
        charge_type:
          type: string
        company:
          $ref: '#/components/schemas/ResponseCompanyRepresentation'
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        credit_price:
          $ref: '#/components/schemas/ModelCreditPricing'
        custom_price:
          $ref: '#/components/schemas/ModelCustomPricing'
        description:
          type: string
        display_type:
          type: string
        editable:
          type: boolean
        external_name:
          type: string
        fixed_price:
          $ref: '#/components/schemas/ModelFixedPricing'
        frequency:
          type:
            - string
        gradient_price:
          items:
            $ref: '#/components/schemas/ModelGradientPricing'
          type: array
        id:
          type: string
        item:
          $ref: '#/components/schemas/ResponseBillableItemRepresentation'
        item_id:
          type: string
        metadata:
          additionalProperties: true
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
        minimum_spend_schedule:
          $ref: '#/components/schemas/ModelItemPricingMinimumSpendSchedule'
        name:
          type: string
        num_subs:
          minimum: 0
          type: integer
        proration_type:
          type: string
        recognition_schedule:
          $ref: '#/components/schemas/ModelItemPricingRecognitionSchedule'
        scheduled_price:
          $ref: '#/components/schemas/ModelScheduledPricing'
        state:
          type: string
        step_price:
          $ref: '#/components/schemas/ModelStepPricing'
        term_count:
          format: int64
          type: integer
        true_up_frequency:
          type:
            - string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
        volume_price:
          items:
            $ref: '#/components/schemas/ModelVolumePricing'
          type: array
      type: object
    ResponseBillableMetricStringRepresentation:
      properties:
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        description:
          type: string
        external_name:
          type: string
        id:
          type: string
        is_billable:
          type: boolean
        item_id:
          type: string
        metering_rule:
          $ref: '#/components/schemas/ResponseMeteringRuleRepresentation'
        name:
          type: string
        standard:
          type: boolean
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ResponseBundleProductPricingRepresentation:
      properties:
        bundle_pricing_id:
          type: string
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        id:
          type: string
        product:
          $ref: '#/components/schemas/ResponseProductRepresentation'
        product_id:
          type: string
        product_pricing:
          $ref: '#/components/schemas/ResponseProductPricingRepresentation'
        product_pricing_id:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ResponseCompanyRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
        computed_entitlements:
          additionalProperties: {}
          type: object
        created_at:
          format: date-time
          type: string
        customer_id:
          type:
            - 'null'
            - string
        demo:
          type: boolean
        email:
          type: string
        entitlements:
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type: array
        id:
          type: string
        is_dev:
          type: boolean
        legal_name:
          type: string
        name:
          type: string
        override_entitlements:
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type: array
        phone:
          type: string
        preferred_currency:
          type:
            - string
            - 'null'
        preferred_timezone:
          type: string
        slug:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelCreditPricing:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
          description: Amount of credit
        expiration_policy:
          description: Expiration policy for the credit
          enum:
            - END_OF_PRICING_FREQUENCY
            - NEVER
            - END_OF_TERM
          type:
            - 'null'
            - string
        item_id:
          description: Item ID of the credit
          type:
            - 'null'
            - string
        scoped_product_ids:
          description: Product IDs this credit is restricted to. Empty = unrestricted
          items:
            type: string
          type: array
        type:
          description: Type of credit
          enum:
            - AMOUNT
            - UNITS
          type: string
        units:
          description: Units of credit
          exclusiveMinimum: 0
          format: double
          type: number
      required:
        - type
      type: object
    ModelCustomPricing:
      properties:
        max_price_per_unit:
          type: number
        min_price_per_unit:
          type: number
        preset_price_per_unit:
          type: number
        price_per_unit:
          type: number
      type: object
    ModelFixedPricing:
      properties:
        price_per_unit:
          description: Price per unit (in cents)
          type: number
      type: object
    ModelGradientPricing:
      properties:
        end:
          description: End quantity for the row
          minimum: 0
          type: integer
        flat_price:
          description: Flat Price (in cents)
          type: number
        is_custom_tier:
          description: Is custom tier
          type: boolean
        price_per_unit:
          description: Price per unit (in cents)
          type: number
        start:
          description: Start quantity for the row
          minimum: 0
          type: integer
      type: object
    ModelItemPricingMinimumSpendSchedule:
      properties:
        allow_pulling_forward:
          description: Allow pulling forward of minimum spend
          type: boolean
        amount_per_period:
          description: Amount of period per unit (in cents)
          items:
            type: string
          type:
            - 'null'
            - array
        minimum_spend_schedule_type:
          description: Type of minimum spend schedule
          type: string
        term:
          $ref: '#/components/schemas/ModelTerm'
          description: The term of the minimum spend schedule
      type: object
    ModelItemPricingRecognitionSchedule:
      properties:
        amount_per_period:
          description: Amount of period per unit (in cents)
          items:
            type: string
          type:
            - 'null'
            - array
        recognition_schedule_type:
          description: Type of recognition schedule
          enum:
            - IMMEDIATE
            - EVENLY
            - DAILY_EVENLY
            - CUSTOM
            - DONT_RECOGNIZE
          type: string
      type: object
    ModelScheduledPricing:
      properties:
        price_per_unit_per_period:
          description: Price per unit (in cents)
          items:
            type: string
          type:
            - array
            - 'null'
      type: object
    ModelStepPricing:
      properties:
        price_per_step:
          description: Price per step (in cents)
          type: number
        step_size:
          description: Step size
          minimum: 0
          type: integer
      type: object
    ModelVolumePricing:
      properties:
        flat_price:
          description: Flat Price (in cents)
          type: number
        is_custom_tier:
          description: Is custom tier
          type: boolean
        price_per_unit:
          description: Price per unit (in cents)
          type: number
        total_units_end:
          description: End quantity for the row
          minimum: 0
          type: integer
        total_units_start:
          description: Start quantity for the row
          minimum: 0
          type: integer
      type: object
    ResponseMeteringRuleRepresentation:
      properties:
        aggregator:
          type: string
        group_keys:
          items:
            type: string
          type: array
        property:
          type: string
        rule:
          type:
            - 'null'
            - string
      type: object
    ModelAddress:
      properties:
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        country:
          description: 2-character country code (ISO 3166-1 alpha-2)
          examples:
            - US
          type: string
        place_id:
          type:
            - 'null'
            - string
        state:
          type: string
        zip:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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