Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-17101358452.8 KB

eabb28bd0633

OpenMeter Subscriptions

Cancel subscription

Cancels the subscription. Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancelation time.

post/openmeter/subscriptions/{subscriptionId}/cancel

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

Example request

{
  "timing": "2023-01-01T01:01:01.001Z"
}

Response

Subscription updated response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

labelsLabels

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 "_".

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

customer_idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

plan_idstring

ULID (Universally Unique Lexicographically Sortable Identifier).

invoice_currencystring required

Three-letter ISO4217 currency code. Custom three-letter currency codes are also supported for convenience.

cost_basis_mode'dynamic' | 'pinned' required

Controls how custom-currency cost bases are selected for the subscription.

billing_anchorstring date-time required

RFC3339 formatted date-time string in UTC.

status'active' | 'inactive' | 'canceled' | 'scheduled' required

Subscription status.

settlement_mode'credit_then_invoice' | 'credit_only'

Settlement mode for billing.

Values:

  • credit_then_invoice: Credits are applied first, then any remainder is invoiced.
  • credit_only: Usage is settled exclusively against credits.

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "labels": {
    "env": "test"
  },
  "created_at": "2023-01-01T01:01:01.001Z",
  "updated_at": "2023-01-01T01:01:01.001Z",
  "deleted_at": "2023-01-01T01:01:01.001Z",
  "customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "plan_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "invoice_currency": "USD",
  "cost_basis_pins": [
    {
      "custom_currency_id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "invoice_currency": "USD",
      "cost_basis_id": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  ],
  "billing_anchor": "2023-01-01T01:01:01.001Z"
}