> ## 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.

# Update Payment Method

> Update payment methods for this customer from your payment provider (such as Stripe). This endpoint also gives you the option to change all the subscriptions to use this endpoint



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json patch /companies/{company_id}/customers/{customer_id}/payment_methods/{id}
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}/customers/{customer_id}/payment_methods/{id}:
    patch:
      tags:
        - Customers
      summary: Update Payment Method
      description: >-
        Update payment methods for this customer from your payment provider
        (such as Stripe). This endpoint also gives you the option to change all
        the subscriptions to use this endpoint
      operationId: Update_Payment_Method
      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: customer_id
          in: path
          description: customer_id or identifier
          required: true
          schema:
            description: customer_id or identifier
            type: string
        - name: id
          in: path
          description: The resource ID
          required: true
          schema:
            description: The resource ID
            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/RequestUpdatePaymentMethodsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseUpdatePaymentMethodsResponse'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestUpdatePaymentMethodsRequest:
      properties:
        default:
          description: This will change the customer's default payment method'
          type: string
        update_subscriptions_non_default_payment:
          description: >-
            If the customer had specified a payment method when subscribing, we
            will update the subscription the provided payment method
          type: boolean
      type: object
    ResponseUpdatePaymentMethodsResponse:
      properties:
        method:
          $ref: '#/components/schemas/CommonPaymentMethod'
        subscription_customer_pm:
          items:
            $ref: '#/components/schemas/ResponseSubscriptionPaymentMethodsResponse'
          type:
            - array
            - 'null'
      type: object
    CommonPaymentMethod:
      properties:
        billing_email:
          type: string
        brand:
          type: string
        country:
          type: string
        created_at:
          format: date-time
          type: string
        default:
          type: boolean
        exp_month:
          format: int64
          type: integer
        exp_year:
          format: int64
          type: integer
        helcim_payment_method_id:
          type: string
        id:
          type: string
        institution_number:
          type: string
        last_4:
          type: string
        mandate_id:
          type: string
        name:
          type: string
        payment_provider_key:
          type: string
        routing_number:
          type: string
        stripe_cash_balance:
          additionalProperties:
            format: int64
            type: integer
          type: object
        transit_number:
          type: string
        type:
          type: string
      type: object
    ResponseSubscriptionPaymentMethodsResponse:
      properties:
        method:
          $ref: '#/components/schemas/CommonPaymentMethod'
        subscription:
          $ref: '#/components/schemas/ResponseSubscriptionRepresentation'
      type: object
    ResponseSubscriptionRepresentation:
      properties:
        arr:
          $ref: '#/components/schemas/ModelAmount'
          description: The annual recurring revenue for this subscription
        auto_charges:
          description: >-
            Whether the subscription is set up to automatically charge the card
            attached to the subscription or the default payment method on the
            customer
          type: boolean
        auto_renews:
          description: Whether the subscription is set up to automatically renew
          type: boolean
        billing_anchor_date:
          description: >-
            The billing anchor date for this subscription, typically the same as
            the start date
          format: date-time
          type: string
        bundle_pricing:
          $ref: '#/components/schemas/ResponseBundlePricingRepresentation'
          description: The expanded bundle pricing attached to this subscription
        bundle_pricing_id:
          description: The bundle of product pricings attached to this subscription
          type: string
        cancel_config:
          $ref: '#/components/schemas/ModelSubscriptionCancelConfig'
          description: Any cancel request information for this subscription
        cancel_date:
          description: >-
            The date this subscription was cancelled. The end date represents
            the date that the subscription will actually cancel
          format: date-time
          type:
            - 'null'
            - string
        change_config:
          $ref: '#/components/schemas/ModelSubscriptionChangeConfig'
          description: Any change request information for this subscription
        change_date:
          description: The date this subscription is due to change to a different plan
          format: date-time
          type:
            - 'null'
            - string
        change_history:
          description: A history of changes to the subscription
          items:
            $ref: >-
              #/components/schemas/ResponseSubscriptionChangeConfigRepresentation
          type:
            - array
            - 'null'
        company:
          $ref: '#/components/schemas/ResponseCompanyRepresentation'
          description: The expanded company details for the subscription
        company_id:
          description: The company ID of the subscription
          type: string
        computed_entitlements:
          description: Computed entitlements attached to this subscription
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        config_items:
          description: The mapping of the quantities and the product metric pricings
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type:
            - array
            - 'null'
        created_at:
          description: The date the subscription was created
          format: date-time
          type: string
        customer:
          $ref: '#/components/schemas/ResponseCustomerRepresentation'
          description: The expanded customer details for the subscription
        customer_cancel_reason:
          description: An optional reason provided by the customer for the cancellation
          type:
            - 'null'
            - string
        customer_id:
          description: The customer to which this subscription belongs
          type: string
        discounts:
          description: The discounts attached to the subscription
          items:
            $ref: '#/components/schemas/ResponseDiscountRepresentation'
          type:
            - array
            - 'null'
        end_date:
          description: The end date of the subscription, if there is one
          format: date-time
          type:
            - 'null'
            - string
        id:
          description: The ID of the subscription in Measure
          type: string
        import_created_at_ref:
          description: The date the subscription was created in the import source
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          description: The reference ID in the provider that this subscription maps to
          type:
            - 'null'
            - string
        imported_from:
          description: The provider from which this subscription was imported
          type:
            - 'null'
            - string
        invoice_additional_display_fields:
          description: >-
            Any additional invoice key-value pairs that attached to the invoices
            for this subscription
          items:
            $ref: '#/components/schemas/ModelInvoiceField'
          type:
            - array
            - 'null'
        invoice_due_date_from_creation:
          description: The number of days between the invoice date and the due date
          minimum: 0
          type: integer
        invoice_event_grace_period:
          description: >-
            The grace period (in seconds) for post charge events to be captured
            before invoice is generated
          minimum: 0
          type: integer
        invoice_payment_instructions:
          description: >-
            Payment instructions attached to each invoice generated for the
            subscription. If non-null, overrides the invoice payment
            instructions set at the company-wide setting.
          type:
            - 'null'
            - string
        metadata:
          additionalProperties: true
          description: Any additional data as key-value pairs attached to the subscription
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
          description: The minimum spend for this subscription per billing period
        mrr:
          $ref: '#/components/schemas/ModelAmount'
          description: The monthly recurring revenue for this subscription
        next_invoice_date:
          description: The date the next invoice for this subscription will be available
          format: date-time
          type:
            - 'null'
            - string
        override_entitlements:
          description: Any entitlements attached to this subscription
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        parent_billed:
          description: Whether the subscription is billed to the parent of this customer
          type: boolean
        parent_customer:
          $ref: '#/components/schemas/ResponseCustomerRepresentation'
          description: The parent customer for this subscription
        parent_customer_id:
          description: The parent customer to which this subscription could be billed to
          type:
            - 'null'
            - string
        pause_config:
          $ref: '#/components/schemas/ModelSubscriptionPauseConfig'
          description: Any pause request information for this subscription
        pause_date:
          description: The date this subscription was paused for collection
          format: date-time
          type:
            - 'null'
            - string
        payment_method:
          $ref: '#/components/schemas/ModelRecurringPaymentData'
          description: The payment data attached with the subscription
        payment_method_id:
          deprecated: true
          description: >-
            The payment method for this subscription, if available. Use
            'paymentMethod' instead
          type:
            - 'null'
            - string
        product_pricing_ids:
          description: >-
            The list of plans that are part of this subscription along with the
            quantities and minimum purchased units per metric under the plan
          items:
            type: string
          type:
            - array
            - 'null'
        product_pricings:
          description: >-
            The list of plans that are part of this subscription along with the
            quantities and minimum purchased units per metric under the plan
          items:
            $ref: >-
              #/components/schemas/ResponseSubscriptionProductPricingRepresentation
          type:
            - array
            - 'null'
        renewal_date:
          description: The renewal date of the subscription, if there is one
          format: date-time
          type:
            - 'null'
            - string
        sales_user:
          $ref: '#/components/schemas/ResponseSalesUserRepresentation'
          description: The commissionable user if there is one present
        sales_user_id:
          description: The ID of the commissionable user if there is one present
          type:
            - 'null'
            - string
        scheduled_changes:
          description: A list of scheduled changes to the subscription.
          items:
            $ref: '#/components/schemas/ModelSubscriptionChangeConfig'
          type:
            - array
            - 'null'
        start_date:
          description: The start date of the subscription
          format: date-time
          type: string
        status:
          description: >-
            The subscription status which can be one of active, cancelled or
            unpaid
          type: string
        tags:
          description: Tags attached to the subscription
          items:
            type: string
          type:
            - array
            - 'null'
        term:
          $ref: '#/components/schemas/ModelTerm'
          description: >-
            The term for the subscription, broken into the intervals and the
            number of intervals
        trial:
          description: Whether the subscription is a trial
          type: boolean
        trial_conversion_date:
          description: >-
            The date the trial converted to an active subscription, remains null
            if trial does not convert
          format: date-time
          type:
            - 'null'
            - string
        updated_at:
          description: The date the subscription was last updated
          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
    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
    ModelSubscriptionCancelConfig:
      properties:
        campaign_id:
          type: string
        campaign_step_id:
          type: string
        charge_remaining_balance:
          type:
            - 'null'
            - boolean
        custom_end_date:
          format: date-time
          type:
            - 'null'
            - string
        custom_refund_amount:
          $ref: '#/components/schemas/ModelAmount'
        reason:
          type:
            - 'null'
            - string
        refund_type:
          type: string
        send_customer_receipt:
          type:
            - 'null'
            - boolean
        timing:
          type: string
      type: object
    ModelSubscriptionChangeConfig:
      properties:
        actual_change_time:
          format: date-time
          type:
            - 'null'
            - string
        all_product_pricings:
          items:
            $ref: '#/components/schemas/ModelProductPricing'
          type: array
        auto_charges:
          type:
            - 'null'
            - boolean
        auto_renews:
          type:
            - 'null'
            - boolean
        bundle_pricing:
          $ref: '#/components/schemas/ModelBundlePricing'
        bundle_pricing_id:
          type:
            - 'null'
            - string
        config_items:
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type:
            - array
            - 'null'
        custom_change_date:
          format: date-time
          type:
            - 'null'
            - string
        discounts:
          items:
            $ref: '#/components/schemas/ModelDiscountParams'
          type:
            - 'null'
            - array
        metadata:
          additionalProperties: true
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
        onetime_items:
          items:
            $ref: '#/components/schemas/ModelOneTimeParams'
          type:
            - array
            - 'null'
        payment_method_id:
          type:
            - 'null'
            - string
        product_pricing_ids:
          items:
            type: string
          type:
            - array
            - 'null'
        proration_type:
          enum:
            - NEXT
            - IMMEDIATE
            - NONE
          type:
            - string
            - 'null'
        relative_term:
          $ref: '#/components/schemas/ModelTerm'
        reset_billing_anchor:
          type:
            - 'null'
            - boolean
        term:
          $ref: '#/components/schemas/ModelTerm'
        timing:
          enum:
            - IMMEDIATE
            - PERIOD_END
            - RENEWAL
            - CUSTOM
            - RELATIVE
          type:
            - string
            - 'null'
        trial:
          type:
            - 'null'
            - boolean
        trial_term:
          $ref: '#/components/schemas/ModelTerm'
      required:
        - timing
        - proration_type
      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
    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
    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
    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
    ResponseCustomerRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
          description: The address of the customer
        arr:
          $ref: '#/components/schemas/ModelAmount'
          description: The ARR of the customer
        billing_emails:
          description: The additional emails to cc on customer's invoices
          items:
            type: string
          type:
            - array
            - 'null'
        child_rollup_billing:
          description: Whether child invoices are rolled up
          type: boolean
        child_rollup_billing_config:
          $ref: '#/components/schemas/ModelChildRollupBillingConfig'
          description: The details of the child invoice rollup configuration
        child_rollup_next_invoice_date:
          description: The next child rollup invoice
          format: date-time
          type:
            - 'null'
            - string
        company_id:
          description: The company ID of the customer
          type: string
        computed_entitlements:
          description: The computed entitlements for the customer
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        created_at:
          description: The date the customer was created
          format: date-time
          type: string
        customer_integration_metadata:
          additionalProperties:
            $ref: '#/components/schemas/ModelCustomerIntegrationMetadata'
          type: object
        customer_uploads:
          description: The list of uploaded documents for this customer
          items:
            $ref: '#/components/schemas/ResponseCustomerUploadRepresentation'
          type:
            - array
            - 'null'
        customer_virtual_bank_account:
          $ref: '#/components/schemas/ResponseCustomerVirtualAccountResponse'
        display_name:
          description: The computed display name of the customer
          type: string
        email:
          description: The email of the customer
          type: string
        exclude_from_metrics:
          description: >-
            Whether to exclude this customer and related fields from any metrics
            in Measure
          type: boolean
        id:
          description: The ID of the customer in Measure
          type: string
        identifier:
          description: >-
            The unique identifier for the customer that ties back to your
            system. You can query for a customer using this identifier
          type: string
        import_created_at_ref:
          description: The date the customer was created in the import source
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          description: The import reference ID for the customer
          type:
            - 'null'
            - string
        imported_from:
          description: Where the customer is imported from
          type:
            - 'null'
            - string
        integration_references:
          description: >-
            The integration references of this customer in third-party
            applications connected to Measure
          items:
            $ref: '#/components/schemas/ResponseCustomerIntegrationRefs'
          type: array
        invalid_emails:
          items:
            type: string
          type: array
        invoice_additional_display_fields:
          items:
            $ref: '#/components/schemas/ModelInvoiceField'
          type: array
        invoice_next_seq_num:
          minimum: 0
          type:
            - 'null'
            - integer
        invoice_prefix:
          description: >-
            This is only used if the "Customer-Level Invoice Number"
            functionality is enabled. The prefix must be all uppercase letters
            and a max of 12 letters.
          type:
            - 'null'
            - string
        locale:
          description: The locale of the customer
          type: string
        managed_externally:
          description: Whether this customer is managed outside of Measure
          type: boolean
        metadata:
          additionalProperties: true
          description: The metadata as key-value pairs attached to this customer
          type: object
        mrr:
          $ref: '#/components/schemas/ModelAmount'
          description: The MRR of the customer
        name:
          description: The name of the customer
          type: string
        org_name:
          description: >-
            The name of the company or the organization this customer is a part
            of
          type: string
        owner:
          $ref: '#/components/schemas/ResponseCompanyUserRepresentation'
          description: The owner of the customer in Measure
        owner_id:
          description: >-
            The company user ID of person in Measure assigned to manage this
            customer
          type:
            - 'null'
            - string
        parent_customer:
          $ref: '#/components/schemas/ResponseCustomerRepresentation'
          description: The parent customer of the customer in Measure
        parent_customer_id:
          description: The customer ID of the parent customer assigned in Measure
          type:
            - 'null'
            - string
        phone:
          description: The phone number of the customer
          type: string
        status:
          description: The status of the customer such as ACTIVE or ARCHIVED
          type: string
        subscriptions:
          description: The list of subscriptions for this customer
          items:
            $ref: '#/components/schemas/ResponseCustomerSubscriptionRepresentation'
          type:
            - array
            - 'null'
        tags:
          description: Tags attached to the customer
          items:
            type: string
          type:
            - array
            - 'null'
        title:
          description: The title of the customer, such as CEO, VP
          type: string
        updated_at:
          description: The date the customer was last updated
          format: date-time
          type: string
      type: object
    ResponseDiscountRepresentation:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
        cap:
          $ref: '#/components/schemas/ModelAmount'
        coupon:
          $ref: '#/components/schemas/ResponseCouponRepresentation'
        coupon_id:
          type:
            - 'null'
            - string
        created_at:
          format: date-time
          type: string
        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:
          $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation'
        item_pricing_id:
          type:
            - 'null'
            - string
        name:
          type: string
        one_time_billable:
          $ref: '#/components/schemas/ResponseOneTimeRepresentation'
        one_time_billable_id:
          type:
            - 'null'
            - string
        percent:
          format: double
          type: number
        product:
          $ref: '#/components/schemas/ResponseProductRepresentation'
        product_id:
          type:
            - 'null'
            - string
        product_pricing:
          $ref: '#/components/schemas/ResponseProductPricingRepresentation'
        product_pricing_id:
          type:
            - 'null'
            - string
        proposal:
          $ref: '#/components/schemas/ResponseProposalRepresentation'
        proposal_id:
          type:
            - 'null'
            - string
        state:
          type: string
        subscription:
          $ref: '#/components/schemas/ResponseSubscriptionRepresentation'
        subscription_id:
          type:
            - 'null'
            - string
        type:
          type: string
      type: object
    ModelInvoiceField:
      properties:
        name:
          type: string
        value:
          type: string
      type: object
    ModelSubscriptionPauseConfig:
      properties:
        behavior:
          type: string
        resume_date:
          format: date-time
          type:
            - 'null'
            - string
      required:
        - behavior
      type: object
    ModelRecurringPaymentData:
      properties:
        helcim:
          $ref: '#/components/schemas/ModelRecurringHelcimParams'
        payment_provider_key:
          enum:
            - stripe
            - helcim
          type: string
        razor_pay:
          $ref: '#/components/schemas/ModelRecurringRazorPayParams'
        stripe:
          $ref: '#/components/schemas/ModelRecurringStripeParams'
      type: object
    ResponseSubscriptionProductPricingRepresentation:
      properties:
        created_at:
          description: The date this product pricing was created
          format: date-time
          type: string
        currency:
          description: The currency for the product pricing
          type:
            - string
            - 'null'
        external_name:
          description: The externally exposed name for the product pricing
          type: string
        id:
          description: The ID of the product pricing
          type: string
        name:
          description: The name of the product pricing
          type: string
        product:
          $ref: '#/components/schemas/ResponseProductRepresentation'
          description: The expanded product for the product pricing
        product_id:
          description: The ID of the product
          type: string
        product_metric_pricings:
          description: The metric components of the product pricing plan
          items:
            $ref: >-
              #/components/schemas/ResponseSubscriptionProductMetricPricingRepresentation
          type:
            - array
            - 'null'
        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 this product pricing was updated
          format: date-time
          type: string
      type: object
    ResponseSalesUserRepresentation:
      properties:
        company:
          $ref: '#/components/schemas/ResponseCompanyRepresentation'
        company_id:
          type: string
        company_user:
          $ref: '#/components/schemas/ResponseCompanyUserRepresentation'
        company_user_id:
          type:
            - 'null'
            - string
        created_at:
          format: date-time
          type: string
        display_email:
          type: string
        display_name:
          type: string
        email:
          type:
            - 'null'
            - string
        id:
          type: string
        name:
          type:
            - 'null'
            - string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      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
    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
    ModelProductPricing:
      properties:
        company_id:
          type: string
        computed_entitlements:
          items:
            $ref: '#/components/schemas/ModelEntitlementData'
          type:
            - array
            - 'null'
        created_at:
          format: date-time
          type: string
        currency:
          type:
            - string
            - 'null'
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        description:
          type: string
        external_name:
          type: string
        id:
          type: string
        import_created_at_ref:
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        metadata:
          additionalProperties: true
          type: object
        minimum_spend:
          $ref: '#/components/schemas/ModelAmount'
        name:
          type: string
        num_subs:
          minimum: 0
          type: integer
        override_entitlements:
          items:
            $ref: '#/components/schemas/ModelEntitlementData'
          type:
            - array
            - 'null'
        product_id:
          type: string
        product_metric_pricings:
          items:
            $ref: '#/components/schemas/ModelProductMetricPricing'
          type:
            - array
            - 'null'
        state:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
        upsell_product_pricing:
          $ref: '#/components/schemas/ModelProductPricing'
        upsell_product_pricing_id:
          type:
            - 'null'
            - string
      type: object
    ModelBundlePricing:
      properties:
        bundle_product_pricings:
          items:
            $ref: '#/components/schemas/ModelBundleProductPricing'
          type:
            - array
            - 'null'
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        currency:
          type:
            - string
            - 'null'
        default_term:
          $ref: '#/components/schemas/ModelTerm'
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        description:
          type: string
        id:
          type: string
        image_url:
          type: string
        import_created_at_ref:
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        is_auto_generated:
          type: boolean
        key:
          type: string
        metadata:
          additionalProperties: true
          type: object
        name:
          type: string
        num_subs:
          minimum: 0
          type: integer
        state:
          type: string
        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
    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
    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
    ModelQuantityConfig:
      properties:
        allow_custom_quantity:
          type: boolean
        max_quantity:
          type: integer
        min_quantity:
          type: integer
      type: object
    ModelChildRollupBillingConfig:
      description: The configuration for child rollup billing
      properties:
        auto_charges:
          description: >-
            Whether the rollup invoice is automatically charged on the customer
            payment method
          type:
            - 'null'
            - boolean
        end_date:
          description: The last date of the rollup invoice generation
          format: date-time
          type:
            - 'null'
            - string
        frequency:
          description: The frequency at which the rollup invoice is generated
          enum:
            - HOUR
            - DAY
            - WEEK
            - BI_MONTH
            - MONTH
            - QUARTER
            - BI_ANNUAL
            - YEAR
          type:
            - string
        invoice_additional_display_fields:
          description: >-
            Any additional metadata fields to be displayed on the rollup invoice
            such as a PO number, payment details etc.
          items:
            $ref: '#/components/schemas/ModelInvoiceField'
          type:
            - array
            - 'null'
        invoice_due_date_from_creation:
          description: The net terms of the rollup invoice generated
          minimum: 0
          type:
            - 'null'
            - integer
        start_date:
          description: The start date of the rollup invoice generation
          format: date-time
          type:
            - string
      required:
        - frequency
        - start_date
      type:
        - object
        - 'null'
    ModelCustomerIntegrationMetadata:
      properties:
        anrok:
          $ref: '#/components/schemas/ModelAnrokCustomerIntegrationMetadata'
        avalara:
          $ref: '#/components/schemas/ModelAvalaraCustomerIntegrationMetadata'
      type: object
    ResponseCustomerUploadRepresentation:
      properties:
        created_at:
          format: date-time
          type: string
        file_id:
          type: string
        id:
          type: string
        original_filename:
          type: string
      type: object
    ResponseCustomerVirtualAccountResponse:
      properties:
        bank_details:
          $ref: '#/components/schemas/ModelBankIntegrationDetails'
        company_id:
          type: string
        currency:
          type:
            - string
            - 'null'
        customer_id:
          type: string
        customer_provider_id:
          type: string
      required:
        - customer_id
        - customer_provider_id
        - company_id
        - currency
      type: object
    ResponseCustomerIntegrationRefs:
      properties:
        integration_icon:
          type: string
        integration_id:
          type: string
        integration_key:
          type: string
        integration_name:
          type: string
        reference_type:
          type: string
        remote_id:
          type: string
        remote_type:
          type: string
      type: object
    ResponseCompanyUserRepresentation:
      properties:
        access:
          $ref: '#/components/schemas/ModelCompanyUserAccess'
        company:
          $ref: '#/components/schemas/ResponseCompanyRepresentation'
        created_at:
          format: date-time
          type: string
        id:
          type: string
        image_url:
          type: string
        manager_id:
          type:
            - 'null'
            - string
        pending:
          type: boolean
        role:
          type: string
        title:
          type: string
        updated_at:
          format: date-time
          type: string
        user:
          $ref: '#/components/schemas/ResponseUserRepresentation'
      type: object
    ResponseCustomerSubscriptionRepresentation:
      properties:
        computed_entitlements:
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        id:
          type: string
        status:
          type: string
      type: object
    ResponseCouponRepresentation:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
        cap:
          $ref: '#/components/schemas/ModelAmount'
        created_at:
          format: date-time
          type: string
        duration:
          type: string
        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:
          $ref: '#/components/schemas/ResponseBillableItemRepresentation'
        item_id:
          type:
            - 'null'
            - string
        item_pricing:
          $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation'
        item_pricing_id:
          type:
            - 'null'
            - string
        max_redemptions:
          minimum: 0
          type: integer
        metadata:
          additionalProperties: true
          type: object
        months:
          minimum: 0
          type: integer
        name:
          type: string
        num_redemptions:
          minimum: 0
          type: integer
        percent:
          format: double
          type: number
        product_pricing:
          $ref: '#/components/schemas/ResponseProductPricingRepresentation'
        product_pricing_id:
          type:
            - 'null'
            - string
        products:
          items:
            type: string
          type:
            - array
            - 'null'
        promo_codes:
          items:
            $ref: '#/components/schemas/ResponsePromoCodeRepresentation'
          type:
            - array
            - 'null'
        state:
          type: string
        type:
          type: string
        units:
          format: double
          type: number
      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
    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
    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
    ResponseProposalRepresentation:
      properties:
        acv:
          $ref: '#/components/schemas/ModelAmount'
        auto_charges:
          type: boolean
        auto_renews:
          type: boolean
        billing_anchor_date:
          format: date-time
          type:
            - 'null'
            - string
        bundle_pricing:
          $ref: '#/components/schemas/ResponseBundlePricingRepresentation'
        bundle_pricing_id:
          type: string
        campaigns:
          items:
            $ref: '#/components/schemas/ResponseCampaignRepresentation'
          type:
            - array
            - 'null'
        change_custom_date:
          format: date-time
          type:
            - 'null'
            - string
        change_proration_type:
          type:
            - string
            - 'null'
        change_reset_billing_anchor:
          type:
            - 'null'
            - boolean
        change_timing:
          type:
            - string
            - 'null'
        company:
          $ref: '#/components/schemas/ResponseCompanyRepresentation'
        company_id:
          type: string
        completed_date:
          format: date-time
          type:
            - 'null'
            - string
        config_items:
          items:
            $ref: '#/components/schemas/ModelSubscriptionConfigItem'
          type:
            - array
            - 'null'
        content:
          type:
            - 'null'
            - string
        content_template:
          type:
            - 'null'
            - string
        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
        currency:
          type:
            - string
            - 'null'
        custom_variables:
          additionalProperties: {}
          type:
            - object
            - 'null'
        customer:
          $ref: '#/components/schemas/ResponseProposalCustomerRepresentation'
        customer_id:
          type:
            - 'null'
            - string
        description:
          type:
            - 'null'
            - string
        discounts:
          items:
            $ref: '#/components/schemas/ModelDiscount'
          type:
            - array
            - 'null'
        error_status_details:
          items:
            $ref: '#/components/schemas/ResponseProposalErrorRepresentation'
          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
        invoice_payment_instructions:
          description: >-
            Payment instructions attached to each invoice generated for the
            contract. If non-null, overrides the invoice payment instructions
            set at the company-wide setting.
          type:
            - 'null'
            - string
        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:
          $ref: '#/components/schemas/ResponseProposalCompanyUserRepresentation'
        owner_id:
          type:
            - 'null'
            - string
        parent_billed:
          type: boolean
        payment_config:
          $ref: '#/components/schemas/ResponsePaymentConfigRepresentation'
        payment_data:
          $ref: '#/components/schemas/ModelRecurringPaymentData'
        payment_provided_date:
          format: date-time
          type:
            - 'null'
            - string
        po_number:
          type:
            - 'null'
            - string
        previous_arr:
          $ref: '#/components/schemas/ModelAmount'
        previous_sub_change:
          items:
            $ref: '#/components/schemas/ModelCheckoutPageData'
          type: array
        previous_subscription:
          $ref: '#/components/schemas/ResponseSubscriptionProposalRepresentation'
        previous_subscription_id:
          type:
            - 'null'
            - string
        processing_date:
          format: date-time
          type:
            - 'null'
            - string
        proposal_link_id:
          type:
            - 'null'
            - string
        quote_plans:
          items:
            $ref: '#/components/schemas/ResponseQuotePlanRepresentation'
          type:
            - 'null'
            - array
        require_payment_method:
          type: boolean
        requires_customer_confirmation:
          type: boolean
        sales_user:
          $ref: '#/components/schemas/ResponseSalesUserRepresentation'
          description: The commissionable user if there is one present
        sales_user_id:
          description: The ID of the commissionable user if there is one present
          type:
            - 'null'
            - string
        scheduled_changes:
          items:
            $ref: '#/components/schemas/ModelSubscriptionChangeConfig'
          type:
            - array
            - 'null'
        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
        subscription:
          $ref: '#/components/schemas/ResponseSubscriptionProposalRepresentation'
        subscription_id:
          type:
            - 'null'
            - string
        tcv:
          $ref: '#/components/schemas/ModelAmount'
        template_id:
          type:
            - 'null'
            - string
        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
        variable_configs:
          items:
            $ref: '#/components/schemas/ModelVariableConfig'
          type:
            - array
            - 'null'
      type: object
    ModelRecurringHelcimParams:
      properties:
        payment_method_id:
          type:
            - 'null'
            - string
      type: object
    ModelRecurringRazorPayParams:
      properties:
        token_id:
          type:
            - string
            - 'null'
      type: object
    ModelRecurringStripeParams:
      properties:
        payment_method_id:
          type: string
      type: object
    ResponseSubscriptionProductMetricPricingRepresentation:
      properties:
        created_at:
          description: The date this product metric pricing was created
          format: date-time
          type: string
        id:
          description: The ID of the product metric pricing
          type: string
        item:
          $ref: '#/components/schemas/ResponseBillableItemRepresentation'
          description: The expanded billable item object
        item_id:
          description: The billable item ID
          type: string
        item_pricing:
          $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation'
          description: The expanded billable item pricing object
        item_pricing_id:
          description: The billable item pricing ID
          type: string
        metric:
          $ref: '#/components/schemas/ResponseBillableMetricStringRepresentation'
          description: The expanded billable metric object
        metric_id:
          description: The billable metric ID
          type: string
        minimum_units:
          description: The minimum units committed for this product metric pricing
          format: double
          type: number
        num_licenses:
          description: The number of licenses for this product metric pricing
          format: double
          type: number
        updated_at:
          description: The date this product metric pricing was updated
          format: date-time
          type: string
      type: object
    ModelEntitlementData:
      properties:
        entitlement_id:
          type: string
        id:
          type: string
        inherited_from_id:
          type:
            - 'null'
            - string
        inherited_from_type:
          type:
            - 'null'
            - string
        key:
          type: string
        original_value: {}
        overriden:
          type:
            - 'null'
            - boolean
        value: {}
      type: object
    GormDeletedAt:
      type: object
    ModelProductMetricPricing:
      properties:
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        id:
          type: string
        item_id:
          type: string
        item_pricing_id:
          type: string
        metric_id:
          type: string
        product_id:
          type: string
        product_pricing_id:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelBundleProductPricing:
      properties:
        bundle_pricing_id:
          type: string
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        id:
          type: string
        product_id:
          type: string
        product_pricing_id:
          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
    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
    ModelAnrokCustomerIntegrationMetadata:
      properties:
        vat_id:
          type: string
      type: object
    ModelAvalaraCustomerIntegrationMetadata:
      properties:
        entity_code:
          type: string
      type: object
    ModelBankIntegrationDetails:
      properties:
        ach_account_number:
          type: string
        ach_bank_name:
          type: string
        ach_routing_number:
          type: string
        swift_account_number:
          type: string
        swift_bank_name:
          type: string
        swift_code:
          type: string
      required:
        - ach_bank_name
        - ach_account_number
        - ach_routing_number
        - swift_bank_name
        - swift_account_number
        - swift_code
      type: object
    ModelCompanyUserAccess:
      properties:
        api_tokens:
          type: string
        approvals:
          type: string
        campaign:
          type: string
        commission_plans:
          type: string
        commission_reports:
          type: string
        companies:
          type: string
        credit_notes:
          type: string
        credits:
          type: string
        customer_portal:
          type: string
        customers:
          type: string
        developers:
          type: string
        disputes:
          type: string
        email_templates:
          type: string
        entitlement:
          type: string
        events:
          type: string
        expired_card:
          type: string
        files:
          type: string
        import:
          type: string
        integration_bank_accounts:
          type: string
        integration_transactions:
          type: string
        integrations:
          type: string
        invoices:
          type: string
        journal_accounts:
          type: string
        journal_entries:
          type: string
        logs:
          type: string
        objects:
          type: string
        one_time:
          type: string
        payments:
          type: string
        pricing:
          type: string
        promotions:
          type: string
        proposal:
          type: string
        reports:
          type: string
        sales_users:
          type: string
        settings:
          type: string
        subscriptions:
          type: string
        team:
          type: string
        webhooks:
          type: string
      type: object
    ResponseUserRepresentation:
      properties:
        companies:
          items:
            $ref: '#/components/schemas/ResponseCompanyUserAccessRepresentation'
          type: array
        created_at:
          format: date-time
          type: string
        email:
          type: string
        id:
          type: string
        is_super_user:
          type: boolean
        maple_employee_role:
          type:
            - 'null'
            - string
        name:
          type: string
        otp_enabled:
          type: boolean
        updated_at:
          format: date-time
          type: string
        verified:
          type: boolean
      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
    ResponsePromoCodeRepresentation:
      properties:
        code:
          type: string
        coupon_id:
          type: string
        created_at:
          format: date-time
          type: string
        description:
          type: string
        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
        max_redemptions:
          format: int64
          type: integer
        metadata:
          additionalProperties: true
          type: object
        num_redemptions:
          format: int64
          type: integer
        restrictions:
          additionalProperties: true
          type: object
        state:
          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
      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
    ResponseCampaignRepresentation:
      properties:
        amount:
          $ref: '#/components/schemas/ModelAmount'
        created_at:
          format: date-time
          type: string
        current_step:
          minimum: 0
          type: integer
        customer:
          $ref: '#/components/schemas/ResponseCampaignCustomerRepresentation'
        id:
          type: string
        invoice:
          $ref: '#/components/schemas/ResponseInvoiceLiteRepresentation'
        next_action_in:
          format: date-time
          type:
            - 'null'
            - string
        next_action_type:
          type:
            - 'null'
            - string
        proposal:
          $ref: '#/components/schemas/ResponseProposalRepresentation'
        status:
          type: string
        steps:
          items:
            $ref: '#/components/schemas/ResponseCampaignStepRepresentation'
          type: array
        time_from_reference_data:
          format: date-time
          type:
            - 'null'
            - string
        total_steps:
          minimum: 0
          type: integer
        type:
          type: string
        updated_at:
          format: date-time
          type: 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
    ResponseProposalCustomerRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
          description: The address of the customer
        billing_emails:
          items:
            type: string
          type:
            - array
            - 'null'
        email:
          type: string
        id:
          type: string
        identifier:
          type: string
        name:
          type: string
        org_name:
          type: string
        owner_id:
          type:
            - 'null'
            - string
        parent_customer:
          $ref: '#/components/schemas/ResponseProposalCustomerRepresentation'
        parent_customer_id:
          type:
            - 'null'
            - string
        phone:
          type: 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
    ResponseProposalErrorRepresentation:
      properties:
        error_message:
          type: string
        error_status:
          type: string
        signature_id:
          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
    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
    ResponsePaymentConfigRepresentation:
      properties:
        account_id:
          type: string
        client_secret:
          type: string
        integration_id:
          type:
            - 'null'
            - string
        live_mode:
          type: boolean
        provider:
          type: string
        razorpay:
          $ref: '#/components/schemas/ResponseRazorpayPaymentConfig'
        stripe:
          $ref: '#/components/schemas/ResponseStripePaymentConfig'
      type: object
    ModelCheckoutPageData:
      properties:
        phases:
          items:
            $ref: '#/components/schemas/ModelCheckoutPhase'
          type:
            - array
            - 'null'
        selectedQuantities:
          additionalProperties:
            $ref: '#/components/schemas/ModelValueHistory'
          type: object
        summary:
          $ref: '#/components/schemas/ModelCheckoutSummary'
        taxesCollected:
          type:
            - 'null'
            - boolean
      type: object
    ResponseSubscriptionProposalRepresentation:
      properties:
        id:
          description: The ID of the subscription in Measure
          type: string
      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
    ModelVariableConfig:
      properties:
        default:
          type: string
        is_custom:
          type: boolean
        is_editable:
          type: boolean
        is_required:
          type:
            - 'null'
            - boolean
        key:
          type: string
        name:
          type: string
        tag:
          type: string
        type:
          type: string
        validation:
          type: string
        value:
          type: string
      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
        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
    ResponseCompanyUserAccessRepresentation:
      properties:
        access:
          $ref: '#/components/schemas/ModelCompanyUserAccess'
        company_id:
          type: string
        company_name:
          type: string
        id:
          type: string
        image_url:
          type: string
        role:
          type: string
      type: object
    ResponseCampaignCustomerRepresentation:
      properties:
        email:
          type: string
        id:
          type: string
        name:
          type: string
        org_name:
          type: string
      type: object
    ResponseInvoiceLiteRepresentation:
      properties:
        auto_charges:
          description: >-
            Whether the invoice is automatically charged to the payment method
            on file for the customer
          type: boolean
        billed_customer:
          $ref: '#/components/schemas/ResponseCustomerLiteRepresentation'
          description: The expanded billed customer details for the invoice
        billed_customer_id:
          description: >-
            The billed customer ID for the invoice. This matches the customer_id
            by default, but can be set to another parent customer ID
          type: string
        created_at:
          description: The date the invoice was created
          format: date-time
          type: string
        currency:
          description: The currency of the invoice
          type:
            - string
            - 'null'
        customer:
          $ref: '#/components/schemas/ResponseCustomerLiteRepresentation'
          description: The expanded customer details for the invoice
        customer_id:
          description: The customer ID for the invoice
          type: string
        due:
          $ref: '#/components/schemas/ModelAmount'
          description: The total amount due on the invoice after any payments
        due_date:
          description: The date the invoice total is due
          format: date-time
          type: string
        hosted_link:
          description: >-
            The hosted link for the invoice. Includes a 1-day authentication
            token in the URL query parameter.
          type:
            - 'null'
            - string
        invoice_date:
          description: The date for the invoice
          format: date-time
          type: string
        name:
          description: The name of the invoice
          type: string
        number:
          description: The invoice number for the invoice
          type: string
        paid:
          $ref: '#/components/schemas/ModelAmount'
          description: The total amount paid against the invoice
        paid_date:
          description: The date the invoice was paid
          format: date-time
          type:
            - 'null'
            - string
        pdf_link:
          description: >-
            The PDF link for the invoice. Includes a 1-day authentication token
            in the URL query parameter.
          type:
            - 'null'
            - string
        prorated_amount:
          $ref: '#/components/schemas/ModelAmount'
          description: Any prorated amounts for the invoice
        revenue:
          $ref: '#/components/schemas/ModelAmount'
          description: The revenue amount of the invoice (total minus credits)
        status:
          description: The status of the invoice such as PAID, DRAFT, VOID or PENDING
          type: string
        sub_total:
          $ref: '#/components/schemas/ModelAmount'
          description: The subtotal of the invoice which is prior to applying credits
        subscription_id:
          description: The subscription ID for the invoice, if is not a one-time invoice
          type:
            - 'null'
            - string
        total:
          $ref: '#/components/schemas/ModelAmount'
          description: >-
            The final total of the invoice after applying all credits, discounts
            and taxes
        updated_at:
          description: The last date the invoice was updated
          format: date-time
          type: string
        uuid:
          description: The unique identifier for the invoice
          type: string
      type: object
    ResponseCampaignStepRepresentation:
      properties:
        action_type:
          type: string
        completed_at:
          format: date-time
          type: string
        enqueued_at:
          format: date-time
          type: string
        id:
          type: string
        notification_log:
          $ref: >-
            #/components/schemas/ResponseCampaignStepNotificationLogRepresentation
        payment_transaction:
          $ref: '#/components/schemas/ResponseCampaignStepPaymentRepresentation'
        status:
          type: string
        step_number:
          minimum: 0
          type: integer
      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
        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
    ResponseProposalUserRepresentation:
      properties:
        email:
          type: string
        id:
          type: string
        name:
          type: string
        verified:
          type: boolean
      type: object
    ResponseRazorpayPaymentConfig:
      properties:
        account_id:
          type: string
      type: object
    ResponseStripePaymentConfig:
      properties:
        account_id:
          type: string
      type: object
    ModelCheckoutPhase:
      properties:
        checkout_line_item:
          items:
            $ref: '#/components/schemas/ModelCheckoutLineItem'
          type:
            - array
            - 'null'
        discount_row:
          items:
            $ref: '#/components/schemas/ModelCheckoutDiscountLineItem'
          type:
            - array
            - 'null'
        minimum_spend:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        minimum_spend_html:
          type: string
        one_time_line_item:
          items:
            $ref: '#/components/schemas/ModelCheckoutLineItem'
          type:
            - array
            - 'null'
        show_taxes:
          type: boolean
      type: object
    ModelValueHistory:
      properties:
        diff:
          type: boolean
        new:
          format: double
          type: number
        old:
          format: double
          type: number
      type: object
    ModelCheckoutSummary:
      properties:
        credits:
          items:
            $ref: '#/components/schemas/ModelCheckoutSummaryItem'
          type: array
        subtotal:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        taxes:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        total:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        totalPaymentsPaid:
          $ref: '#/components/schemas/ModelValueHistory'
        totalPaymentsPending:
          $ref: '#/components/schemas/ModelValueHistory'
        total_without_tax:
          $ref: '#/components/schemas/ModelValueHistoryInt'
      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
    ResponseMeteringRuleRepresentation:
      properties:
        aggregator:
          type: string
        group_keys:
          items:
            type: string
          type:
            - array
            - 'null'
        property:
          type: string
        rule:
          type:
            - 'null'
            - string
      type: object
    ResponseCustomerLiteRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
          description: The address of the customer
        arr:
          $ref: '#/components/schemas/ModelAmount'
          description: The ARR of the customer
        billing_emails:
          description: The additional emails to cc on customer's invoices
          items:
            type: string
          type:
            - array
            - 'null'
        company_id:
          description: The company ID of the customer
          type: string
        computed_entitlements:
          description: The computed entitlements for the customer
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        created_at:
          description: The date the customer was created
          format: date-time
          type: string
        customer_integration_metadata:
          additionalProperties:
            $ref: '#/components/schemas/ModelCustomerIntegrationMetadata'
          type: object
        display_name:
          description: The computed display name of the customer
          type: string
        email:
          description: The email of the customer
          type: string
        exclude_from_metrics:
          description: >-
            Whether to exclude this customer and related fields from any metrics
            in Measure
          type: boolean
        id:
          description: The ID of the customer in Measure
          type: string
        identifier:
          description: >-
            The unique identifier for the customer that ties back to your
            system. You can query for a customer using this identifier
          type: string
        integration_references:
          description: >-
            The integration references of this customer in third-party
            applications connected to Measure
          items:
            $ref: '#/components/schemas/ResponseCustomerIntegrationRefs'
          type: array
        locale:
          description: The locale of the customer
          type: string
        managed_externally:
          description: Whether this customer is managed outside of Measure
          type: boolean
        metadata:
          additionalProperties: true
          description: The metadata as key-value pairs attached to this customer
          type: object
        mrr:
          $ref: '#/components/schemas/ModelAmount'
          description: The MRR of the customer
        name:
          description: The name of the customer
          type: string
        org_name:
          description: >-
            The name of the company or the organization this customer is a part
            of
          type: string
        owner_id:
          description: >-
            The company user ID of person in Measure assigned to manage this
            customer
          type:
            - 'null'
            - string
        parent_customer_id:
          description: The customer ID of the parent customer assigned in Measure
          type:
            - 'null'
            - string
        phone:
          description: The phone number of the customer
          type: string
        status:
          description: The status of the customer such as ACTIVE or ARCHIVED
          type: string
        title:
          description: The title of the customer, such as CEO, VP
          type: string
        updated_at:
          description: The date the customer was last updated
          format: date-time
          type: string
      type: object
    ResponseCampaignStepNotificationLogRepresentation:
      properties:
        cc:
          items:
            type: string
          type:
            - array
            - 'null'
        id:
          type: string
        notification_type:
          type: string
        status:
          type: string
        subject:
          type: string
        to:
          type: string
      type: object
    ResponseCampaignStepPaymentRepresentation:
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: string
        provider_type:
          type: string
        status:
          type: string
        total_amount:
          $ref: '#/components/schemas/ModelAmount'
        total_amount_default_currency:
          $ref: '#/components/schemas/ModelAmount'
        transaction_type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelCheckoutLineItem:
      properties:
        amount:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        amount_html:
          type: string
        currency:
          type:
            - string
            - 'null'
        discount_amount:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        discount_expiration:
          $ref: '#/components/schemas/ModelValueHistoryTime'
        discount_html:
          type: string
        discount_line_items:
          $ref: '#/components/schemas/ModelCheckoutDiscountLineItem'
        discount_name:
          $ref: '#/components/schemas/ModelValueHistoryString'
        discount_percent:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        frequencyName:
          type: string
        id:
          type: string
        item:
          $ref: '#/components/schemas/ModelBillableItem'
        item_pricing:
          $ref: '#/components/schemas/ModelBillableItemPricing'
        product_name:
          type: string
        product_name_display:
          type: string
        product_name_html:
          type: string
        product_pricing_external_name:
          type:
            - 'null'
            - string
        quantity:
          $ref: '#/components/schemas/ModelValueHistory'
        quantity_html:
          type: string
        status:
          type: string
        upsell:
          $ref: '#/components/schemas/ModelUpsellData'
      type: object
    ModelCheckoutDiscountLineItem:
      properties:
        aggregate_price:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        currency:
          type:
            - string
            - 'null'
        discount:
          $ref: '#/components/schemas/ModelDiscount'
        discount_amount:
          $ref: '#/components/schemas/ModelValueHistoryInt'
        discount_html:
          type: string
        discount_percent:
          $ref: '#/components/schemas/ModelValueHistory'
        discount_type:
          type: string
        expiration_date:
          format: date-time
          type:
            - 'null'
            - string
        id:
          type: string
        item:
          $ref: '#/components/schemas/ModelBillableItem'
        name:
          type: string
        prev_discount:
          $ref: '#/components/schemas/ModelDiscount'
        state:
          type:
            - 'null'
            - string
        status:
          type: string
      type: object
    ModelValueHistoryInt:
      properties:
        currency:
          type:
            - string
            - 'null'
        diff:
          type: boolean
        new:
          format: int64
          type: integer
        old:
          format: int64
          type: integer
      type: object
    ModelCheckoutSummaryItem:
      properties:
        key:
          type: string
        type:
          type:
            - 'null'
            - string
        value:
          $ref: '#/components/schemas/ModelValueHistory'
      type: object
    ModelValueHistoryTime:
      properties:
        diff:
          type: boolean
        new:
          format: date-time
          type:
            - 'null'
            - string
        old:
          format: date-time
          type:
            - 'null'
            - string
      type: object
    ModelValueHistoryString:
      properties:
        diff:
          type: boolean
        new:
          type: string
        old:
          type: string
      type: object
    ModelBillableItem:
      properties:
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        credit_count:
          type:
            - 'null'
            - integer
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        description:
          type: string
        display_type:
          type: string
        external_name:
          type: string
        id:
          type: string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        item_pricings:
          items:
            $ref: '#/components/schemas/ModelBillableItemPricing'
          type:
            - array
            - 'null'
        metrics:
          items:
            $ref: '#/components/schemas/ModelBillableMetric'
          type:
            - array
            - 'null'
        name:
          type: string
        standard:
          type: boolean
        state:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelBillableItemPricing:
      properties:
        base_price:
          $ref: '#/components/schemas/ModelAmount'
        base_units:
          format: double
          type: number
        carry_over:
          type: boolean
        charge_type:
          type: string
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        credit_price:
          $ref: '#/components/schemas/ModelCreditPricing'
        custom_price:
          $ref: '#/components/schemas/ModelCustomPricing'
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        description:
          type: string
        display_type:
          type: string
        external_name:
          type: string
        fixed_price:
          $ref: '#/components/schemas/ModelFixedPricing'
        frequency:
          type:
            - string
        gradient_price:
          items:
            $ref: '#/components/schemas/ModelGradientPricing'
          type:
            - array
            - 'null'
        id:
          type: string
        import_created_at_ref:
          format: date-time
          type:
            - 'null'
            - string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        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
        product_metric_pricings:
          items:
            $ref: '#/components/schemas/ModelProductMetricPricing'
          type:
            - array
            - 'null'
        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
            - 'null'
      type: object
    ModelUpsellData:
      properties:
        totalAnnualSavings:
          $ref: '#/components/schemas/ModelValueHistory'
        upsellAggregatePricing:
          $ref: '#/components/schemas/ModelValueHistory'
        upsellFrequency:
          type: string
        upsellState:
          type: boolean
      type: object
    ModelBillableMetric:
      properties:
        company_id:
          type: string
        created_at:
          format: date-time
          type: string
        deleted_at:
          $ref: '#/components/schemas/GormDeletedAt'
        description:
          type: string
        external_name:
          type: string
        id:
          type: string
        import_ref:
          type:
            - 'null'
            - string
        imported_from:
          type:
            - 'null'
            - string
        is_billable:
          type: boolean
        item_id:
          type: string
        metering_rule:
          $ref: '#/components/schemas/ModelMeteringRule'
        name:
          type: string
        product_metric_pricings:
          items:
            $ref: '#/components/schemas/ModelProductMetricPricing'
          type:
            - array
            - 'null'
        standard:
          type: boolean
        state:
          type: string
        type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelMeteringRule:
      properties:
        aggregator:
          type: string
        group_keys:
          items:
            type: string
          type:
            - array
            - 'null'
        property:
          type: string
        rule:
          $ref: '#/components/schemas/ModelMatchingRule'
      type: object
    ModelMatchingRule:
      properties:
        comparator:
          $ref: '#/components/schemas/ModelMatchingRuleComparator'
      type: object
    ModelMatchingRuleComparator:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ModelMatchingRule'
          type: array
        left_item:
          $ref: '#/components/schemas/ModelMatchingRuleItem'
        right_item:
          $ref: '#/components/schemas/ModelMatchingRuleItem'
        type:
          type: string
      type: object
    ModelMatchingRuleItem:
      properties:
        comparator:
          $ref: '#/components/schemas/ModelMatchingRuleComparator'
        item_type:
          type: string
        property:
          type: string
        value:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````