BillingSubscriptionChangeResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingSubscriptionChangeResponse",
  "title": "BillingSubscriptionChangeResponse",
  "description": "Response for changing a subscription.",
  "type": "object",
  "properties": {
    "current": {
      "description": "The current subscription before the change.",
      "type": "object",
      "properties": {
        "id": {
          "description": "ULID (Universally Unique Lexicographically Sortable Identifier).",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "ULID"
        },
        "labels": {
          "$ref": "#/components/schemas/Labels"
        },
        "created_at": {
          "description": "An ISO-8601 timestamp representation of entity creation date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "updated_at": {
          "description": "An ISO-8601 timestamp representation of entity last update date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "deleted_at": {
          "description": "An ISO-8601 timestamp representation of entity deletion date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "customer_id": {
          "description": "The customer ID of the subscription.",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "Customer ID"
        },
        "plan_id": {
          "description": "The plan ID of the subscription.\nSet if subscription is created from a plan.",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "Plan ID"
        },
        "billing_anchor": {
          "description": "A billing anchor is the fixed point in time that determines the subscription's recurring billing cycle.\nIt affects when charges occur and how prorations are calculated.\nCommon anchors:\n- Calendar month (1st of each month): `2025-01-01T00:00:00Z`\n- Subscription anniversary (day customer signed up)\n- Custom date (customer-specified day)",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "Billing anchor"
        },
        "status": {
          "description": "The status of the subscription.",
          "type": "string",
          "enum": [
            "active",
            "inactive",
            "canceled",
            "scheduled"
          ],
          "readOnly": true,
          "title": "Status",
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "customer_id",
        "billing_anchor",
        "status"
      ]
    },
    "next": {
      "description": "The new state of the subscription after the change.",
      "type": "object",
      "properties": {
        "id": {
          "description": "ULID (Universally Unique Lexicographically Sortable Identifier).",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "ULID"
        },
        "labels": {
          "$ref": "#/components/schemas/Labels"
        },
        "created_at": {
          "description": "An ISO-8601 timestamp representation of entity creation date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "updated_at": {
          "description": "An ISO-8601 timestamp representation of entity last update date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "deleted_at": {
          "description": "An ISO-8601 timestamp representation of entity deletion date.",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "RFC3339 Date-Time"
        },
        "customer_id": {
          "description": "The customer ID of the subscription.",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "Customer ID"
        },
        "plan_id": {
          "description": "The plan ID of the subscription.\nSet if subscription is created from a plan.",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "readOnly": true,
          "title": "Plan ID"
        },
        "billing_anchor": {
          "description": "A billing anchor is the fixed point in time that determines the subscription's recurring billing cycle.\nIt affects when charges occur and how prorations are calculated.\nCommon anchors:\n- Calendar month (1st of each month): `2025-01-01T00:00:00Z`\n- Subscription anniversary (day customer signed up)\n- Custom date (customer-specified day)",
          "type": "string",
          "format": "date-time",
          "example": "2023-01-01T01:01:01.001Z",
          "readOnly": true,
          "title": "Billing anchor"
        },
        "status": {
          "description": "The status of the subscription.",
          "type": "string",
          "enum": [
            "active",
            "inactive",
            "canceled",
            "scheduled"
          ],
          "readOnly": true,
          "title": "Status",
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "customer_id",
        "billing_anchor",
        "status"
      ]
    }
  },
  "required": [
    "current",
    "next"
  ]
}