> ## Documentation Index > Fetch the complete documentation index at: https://docs.togai.com/llms.txt > Use this file to discover all available pages before exploring further. # Deactivate usage meter > Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated. ## OpenAPI ````yaml post /usage_meters/{usage_meter_id}/deactivate openapi: 3.0.3 info: version: '1.0' title: Togai Apis contact: email: engg@togai.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html description: APIs for Togai App servers: - description: Api endpoint url: https://api.togai.com/ - description: Sandbox api endpoint url: https://sandbox-api.togai.com/ security: - bearerAuth: [] tags: - name: Customers description: Customer level calls - name: Accounts description: Account level calls - name: Event Schemas description: Event Schema level calls - name: Usage Meters description: Usage Meter level calls - name: Price Plans description: (DEPRECATED) Price Plan level calls - name: PricePlanV2 description: Price Plan V2 level calls - name: Schedules description: Account Schedule level calls - name: Pricing Rules description: Pricing Rules level calls - name: Settings description: Settings - name: Price Experimentation description: Price Experimentation apis - name: InvoiceGroups description: Invoice Group level calls - name: Organization description: Organization level calls - name: FileStorage description: File Storage level calls - name: Aliases description: Alias level calls - name: Reports description: Report level calls - name: ReportTemplates description: Report Template level calls - name: Customer Portal description: Portal level calls - name: Alerts description: Alert level calls - name: Event Management description: APIs for getting events ingested in Togai externalDocs: description: docs url: https://togai.com/docs/billing/events - name: Metrics description: APIs for getting Togai metrics externalDocs: description: docs url: https://togai.com/docs/metrics - name: Licenses description: APIs for getting or updating license records in Togai - name: Entitlements description: APIs related to entitlements - name: Invoices description: Invoices API - name: Credits description: Credits API - name: Wallet description: Wallet API - name: InvoiceTemplates description: InvoiceTemplates API - name: InvoiceSequence description: InvoiceSequence API - name: Payments description: Payments API - name: Authentication description: Authentication API externalDocs: description: Find out more about Togai url: https://docs.togai.com/docs paths: /usage_meters/{usage_meter_id}/deactivate: post: tags: - Usage Meters summary: Deactivate usage meter description: > Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated. operationId: deactivateUsageMeter parameters: - $ref: '#/components/parameters/usage_meter_id' responses: '200': $ref: '#/components/responses/UsageMeterResponse' '400': $ref: '#/components/responses/ErrorResponse' '401': $ref: '#/components/responses/ErrorResponse' '403': $ref: '#/components/responses/ErrorResponse' '404': $ref: '#/components/responses/ErrorResponse' '429': $ref: '#/components/responses/ErrorResponse' default: $ref: '#/components/responses/ErrorResponse' components: parameters: usage_meter_id: in: path name: usage_meter_id required: true schema: type: string maxLength: 50 example: um.1zYnCiM9Bpg.1zYn responses: UsageMeterResponse: description: Response for Create and Get usage event requests content: application/json: schema: $ref: '#/components/schemas/UsageMeter' examples: UsageMeter: $ref: '#/components/examples/UsageMeter' ErrorResponse: description: Error response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: ErrorResponse: summary: Error message value: message: schemas: UsageMeter: description: Structure of usage meter type: object additionalProperties: false required: - id - name - displayName - type - aggregation properties: id: description: Identifier of the usage meter type: string maxLength: 20 name: description: Name of the usage meter type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ example: rides-usage billableName: description: >- Billable name of addon. Billable name takes precedence over name to display in invoice. type: string maxLength: 255 example: Rides Usage displayName: description: > Display name of usage meter. This is an auto-generated field which contains billableName of usage meter. If billableName is not provided, name will be used as display name. type: string maxLength: 255 description: type: string maxLength: 255 example: Meter to track cab rides filters: type: array items: $ref: '#/components/schemas/UsageMeterFilterEntry' type: description: Type of usage meter type: string enum: - COUNTER example: COUNTER status: description: Status of usage meter type: string enum: - DRAFT - ACTIVE - INACTIVE - ARCHIVED example: DRAFT aggregation: $ref: '#/components/schemas/UsageMeterAggregation' computations: type: array minItems: 0 maxItems: 1 items: $ref: '#/components/schemas/Computation' eventSchema: $ref: '#/components/schemas/EventSchema' createdAt: type: string format: date-time lastActivatedAt: type: string format: date-time updatedAt: type: string format: date-time ErrorResponse: type: object additionalProperties: false required: - message properties: message: type: string description: error description maxLength: 500 UsageMeterFilterEntry: description: Filter entry with field and value type: object required: - field - value properties: field: type: string value: type: string UsageMeterAggregation: description: > Aggregation to be applied on usage meter result * COUNT - Counts number of events matching the usage meter * SUM - Sums up results of computation of all events matching usage meter type: string enum: - COUNT - SUM Computation: type: object required: - computation - order properties: id: description: Optional identifier describing the matcher and computation pair type: string maxLength: 50 matcher: description: > Condition to be applied on event. Upon matching it the corresponding computation will be considered for usage_meter unit calculation. The result of the matcher needs to be [truthy](https://jsonlogic.com/truthy.html) in order to be considered as a match. type: string maxLength: 1500 example: | { "and": [ {"in": [{"var": "dimension.city"}, "chennai", "mumbai"]}, "or": [ {">": [{"var": "attribute.distance"}, 100]}, {"<": [{"var": "attribute.distance"}, 20]} ] ] } computation: description: > Computation to be applied on an event if it matches the matcher. In case of a COUNT aggregation type, computation should be passed as '1' type: string maxLength: 500 example: '*': - var: attributes.distance - 0.4 order: description: The order in which multiple matched computations will get evaluated type: integer EventSchema: description: Structure of an event schema type: object additionalProperties: false required: - name - version properties: name: description: Name of the event. Must be unique for an organization. type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ description: description: Description of the event type: string maxLength: 255 version: description: Version of event schema type: integer format: int32 minimum: 1 example: 1 status: description: | Status of event schema * DRAFT - Schema is in draft state * ACTIVE - Schema is currently active * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema type: string enum: - DRAFT - ACTIVE - INACTIVE - ARCHIVED example: DRAFT attributes: type: array maxItems: 50 items: $ref: '#/components/schemas/EventAttributeSchema' uniqueItems: true dimensions: type: array maxItems: 50 items: $ref: '#/components/schemas/DimensionsSchema' uniqueItems: true filterFields: type: array uniqueItems: true items: type: string featureDetails: $ref: '#/components/schemas/FeatureDetails' enrichments: $ref: '#/components/schemas/Enrichments' eventIdTemplate: description: Template used to generate event id based on event payload type: string eventLevelRevenue: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time EventAttributeSchema: description: Structure of an event attribute type: object additionalProperties: false required: - name properties: name: description: Name of the event attribute. type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ example: distance defaultUnit: description: Unit for the attribute type: string maxLength: 10 example: kms DimensionsSchema: description: Structure of dimensions type: object additionalProperties: false required: - name properties: name: description: Name of the event dimension type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ example: city FeatureDetails: description: details of feature associated with event schema with attribute name type: object additionalProperties: false required: - featureId - attributeName properties: featureId: type: string attributeName: type: string Enrichments: type: object additionalProperties: false required: - fields properties: dependencies: type: array items: $ref: '#/components/schemas/Dependency' fields: type: array items: $ref: '#/components/schemas/Field' Dependency: type: object additionalProperties: false required: - type - key - name properties: type: type: string enum: - SETTING key: type: string name: type: string Field: type: object additionalProperties: false required: - name - type - enrichmentType - value - order properties: name: type: string type: type: string enum: - ATTRIBUTE - DIMENSION enrichmentType: type: string enum: - VALUE - JSON_LOGIC - JSON_LOGIC_FROM_DEPENDENCY value: type: string order: type: integer format: int32 examples: UsageMeter: value: id: um.1zlQTBWlkeO.lB7fh name: Rides displayName: Rides description: Cab rides type: COUNTER aggregation: COUNT status: DRAFT computations: - matcher: | { "and": [ {"in": [{"var": "dimension.city"}, "chennai", "mumbai"]}, "or": [ {">": [{"var": "attribute.distance"}, 100]}, {"<": [{"var": "attribute.distance"}, 20]} ] ] } order: 1 computation: '1' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Bearer ````