Sign in
OpenMeter Subscriptions

Unschedule subscription cancelation

Unschedules the subscription cancelation.

post/openmeter/subscriptions/{subscriptionId}/unschedule-cancelation

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

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.

namestring required

Display name of the subscription. Defaults to the plan name when the subscription is created from a plan.

descriptionstring

Optional description of the subscription.

active_fromstring date-time required

RFC3339 formatted date-time string in UTC.

active_tostring 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_cadencestring ISO8601 required

ISO 8601 Duration string.

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.

Changes

Changed in 6 of the 61 revisions of this API.1116

  • v3bd7fb102768411See the full diff
    • ▲

      added CurrencyCode BillingCurrencyCodeCustom to the phases/items/items/items/rate_card/allOf[BillingRateCard]/currency/allOf[BillingCurrencyCode]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed CurrencyCode BillingCurrencyCodeCustom from the phases/items/items/items/rate_card/allOf[BillingRateCard]/currency/allOf[BillingCurrencyCode]/ response property anyOf list for the response status 200

      response-property-any-of-removed

  • v3327f2080730f10See the full diff
    • ○

      added the optional property active_to to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property current_period to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property description to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property plan to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property pro_rating_config to the response with the 200 status

      response-optional-property-added

    • ○

      response property plan_id deprecated

      response-property-deprecated

    • ○

      added the required property active_from to the response with the 200 status

      response-required-property-added

    • ○

      added the required property billing_cadence to the response with the 200 status

      response-required-property-added

    • ○

      added the required property name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property phases to the response with the 200 status

      response-required-property-added

  • v31abd3e0f448b3See the full diff
    • ○

      added the required property cost_basis_mode to the response with the 200 status

      response-required-property-added

    • ○

      added the required property cost_basis_pins to the response with the 200 status

      response-required-property-added

    • ○

      added the required property invoice_currency to the response with the 200 status

      response-required-property-added

  • v33ecbdfd707eb1See the full diff
    • ○

      the settlement_mode response's property default value credit_then_invoice was removed for the status 200

      response-property-default-value-removed

  • v364826b7e87111See the full diff
    • ○

      added the optional property settlement_mode to the response with the 200 status

      response-optional-property-added

  • v39d0042cb38151See the full diff
    • ●

      removed the optional property settlement_mode from the response with the 200 status

      response-optional-property-removed

    This revision also has 112 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog