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

# End a customer plan

> Change the end date of a customer's plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.




## OpenAPI

````yaml /openapi.plans.json post /customers/{customer_id}/plans/{customer_plan_id}/end
openapi: 3.0.1
info:
  title: Metronome
  version: 1.0.0
servers:
  - url: https://api.metronome.com/v1
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: >-
      [Customers](https://docs.metronome.com/provisioning/create-customers/) in
      Metronome represent your users for all billing and reporting. Use these
      endpoints to create, retrieve, update, and archive customers and their
      billing configuration.
  - name: Billable metrics
    description: >-
      [Billable
      metrics](https://docs.metronome.com/understanding-metronome/how-metronome-works#billable-metrics)
      in Metronome represent the various consumption components that Metronome
      meters and aggregates.
  - name: Usage
    description: >-
      [Usage
      events](https://docs.metronome.com/connecting-metronome/send-usage-data/)
      are the basis for billable metrics. Use these endpoints to send usage
      events to Metronome and retrieve aggregated event data.
  - name: Plans
    description: >-
      [Plans](https://docs.metronome.com/pricing-and-packaging/create-plans/)
      determine the base pricing for a customer. Use these endpoints to add a
      plan to a customer, end a customer plan, retrieve plans, and retrieve plan
      details. Create plans in the [Metronome
      app](https://app.metronome.com/plans).
  - name: Contracts
    description: >-
      A contract defines a customer’s products, pricing, discounts, commitments,
      and more. Use these endpoints to create and update contracts data.
  - name: Credit grants
    description: >-
      [Credit
      grants](https://docs.metronome.com/invoicing/how-billing-works/manage-credits/)
      adjust a customer balance for prepayments, reimbursements, promotions, and
      so on. Use these endpoints to create, retrieve, update, and delete credit
      grants.
  - name: Invoices
    description: >-
      [Invoices](https://docs.metronome.com/invoicing/) reflect how much a
      customer spent during a period, which is the basis for billing. Metronome
      automatically generates invoices based upon your pricing, packaging, and
      usage events. Use these endpoints to retrieve invoices.
  - name: Alerts
    description: >-
      [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor
      customer spending, balances, and other billing factors. Use these
      endpoints to create, retrieve, and archive customer alerts. To view sample
      alert payloads by alert type, navigate
      [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications)
  - name: Custom fields
    description: >-
      [Custom fields](https://docs.metronome.com/integrations/custom-fields/)
      enable adding additional data to Metronome entities. Use these endpoints
      to create, retrieve, update, and delete custom fields.
  - name: Security
    description: >-
      [Security](https://docs.metronome.com/developer-resources/security/)
      endpoints allow you to retrieve security-related data.
  - name: Settings
    description: >-
      Use these endpoints to configure a billing API key, a webhook secret, or
      invoice finalization behavior.
paths:
  /customers/{customer_id}/plans/{customer_plan_id}/end:
    post:
      tags:
        - Plans
      summary: End a customer plan
      description: >
        Change the end date of a customer's plan. This is a Plans (deprecated)
        endpoint. New clients should implement using Contracts.
      operationId: endCustomerPlan
      parameters:
        - $ref: '#/components/parameters/CustomerId'
        - $ref: '#/components/parameters/CustomerPlanId'
      requestBody:
        description: The date at which this customer's plan should end
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndCustomerPlanPayload'
            example:
              ending_before: '2021-02-01T00:00:00Z'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                x-stainless-empty-object: true
components:
  parameters:
    CustomerId:
      name: customer_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      example: d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc
    CustomerPlanId:
      name: customer_plan_id
      in: path
      description: the ID of a customer-plan relationship
      required: true
      schema:
        type: string
        format: uuid
      example: 7aa11640-0703-4600-8eb9-293f535a6b74
  schemas:
    EndCustomerPlanPayload:
      type: object
      properties:
        ending_before:
          description: >-
            RFC 3339 timestamp for when the plan ends (exclusive) for this
            customer. Must be at 0:00 UTC (midnight). If not provided, the plan
            end date will be cleared.
          type: string
          format: date-time
        void_invoices:
          description: >-
            If true, plan end date can be before the last finalized invoice
            date. Any invoices generated after the plan end date will be voided.
          type: boolean
        void_stripe_invoices:
          description: >-
            Only applicable when void_invoices is set to true. If true, for
            every invoice that is voided we will also attempt to void/delete the
            stripe invoice (if any). Stripe invoices will be voided if finalized
            or deleted if still in draft state.
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````