---
title: "BillingSubscriptionChange"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c/schemas/BillingSubscriptionChange"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c.md

# BillingSubscriptionChange

Request for changing a subscription.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Metering & Billing
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    BillingSubscriptionEditTimingEnum:
      description: >-
        Subscription edit timing.

        When immediate, the requested changes take effect immediately.

        When next_billing_cycle, the requested changes take effect at the next
        billing cycle.
      type: string
      enum:
        - immediate
        - next_billing_cycle
    DateTime:
      description: "[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time
        string in UTC."
      type: string
      format: date-time
      example: 2023-01-01T01:01:01.001Z
      title: RFC3339 Date-Time
    BillingSubscriptionChange:
      description: Request for changing a subscription.
      type: object
      properties:
        labels:
          $ref: "#/components/schemas/Labels"
        customer:
          description: The customer to create the subscription for.
          type: object
          properties:
            id:
              description: |-
                The ID of the customer to create the subscription for.

                Either customer ID or customer key must be provided.
                If both are provided, the ID will be used.
              type: string
              example: 01G65Z755AFWAKHE12NY0CQ9FH
              pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
              title: Customer ID
            key:
              description: |-
                The key of the customer to create the subscription for.

                Either customer ID or customer key must be provided.
                If both are provided, the ID will be used.
              type: string
              example: 019ae40f-4258-7f15-9491-842f42a7d6ac
              maxLength: 256
              minLength: 1
              title: Customer Key
        plan:
          description: The plan reference of the subscription.
          type: object
          properties:
            id:
              description: >-
                The plan ID of the subscription.

                Set if subscription is created from a plan.


                ID or Key of the plan is required if creating a subscription
                from a plan.

                If both are provided, the ID will be used.
              type: string
              example: 01G65Z755AFWAKHE12NY0CQ9FH
              pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
              title: Plan ID
            key:
              description: >-
                The plan Key of the subscription, if any.

                Set if subscription is created from a plan.


                ID or Key of the plan is required if creating a subscription
                from a plan.

                If both are provided, the ID will be used.
              type: string
              example: resource_key
              maxLength: 64
              minLength: 1
              pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$
              title: Plan Key
            version:
              description: |-
                The plan version of the subscription, if any.
                If not provided, the latest version of the plan will be used.
              type: integer
              title: Plan Version
        billing_anchor:
          description: >-
            A billing anchor is the fixed point in time that determines the
            subscription's recurring billing cycle.

            It affects when charges occur and how prorations are calculated.

            Common anchors:

            - Calendar month (1st of each month): `2025-01-01T00:00:00Z`

            - Subscription anniversary (day customer signed up)

            - Custom date (customer-specified day)


            If not provided, the subscription will be created with the
            subscription's creation time as the billing anchor.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: Billing anchor
        timing:
          description: >-
            Timing configuration for the change, when the change should take
            effect.

            For changing a subscription, the accepted values depend on the
            subscription configuration.
          example: immediate
          oneOf:
            - $ref: "#/components/schemas/BillingSubscriptionEditTimingEnum"
            - $ref: "#/components/schemas/DateTime"
      required:
        - customer
        - plan
        - timing
```
