---
title: "Resume a Subscription"
method: POST
path: "/subscriptions/{id}/resume"
tags: ["Subscriptions"]
---

# Resume a Subscription

`POST /subscriptions/{id}/resume`

Reverts a scheduled cancellation for a Subscription, whichever cycle it was booked against

## Path parameters

- `id` string, required

## Response `200`

OK

- SubscriptionDTO
  - `createdAt` string, date-time, required — The date and time when the entity was created.
  - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
  - `metadata` object, nullable — Metadata used by merchants to store additional information about the entity.
  - `id` string, required — The ID of the subscription
  - `status` 'active' | 'cancelled', required — The status of the subscription
  - `isRecovering` boolean, required — Whether the subscription is recovering from a failed payment
  - `autoBillingEnabled` boolean, required — Whether the subscription is going to be billed automatically
  - `autoBillingDisabledAt` string, date-time, nullable, required — The date when auto billing was disabled
  - `autoBillingDisabledReason` 'recurring_payment_errored' | 'subscription_cancelled' | 'latest_invoice_retrying' | 'null', nullable, required — The reason why auto billing was disabled
  - `startDate` string, date-time, required — The start date of the subscription
  - `endDate` string, date-time, nullable, required — The end date of the subscription, if it has ended
  - `cancelAtPeriodEnd` boolean, required — Whether the subscription should be cancelled when current billing cycle ends
  - `cancelAtCycle` number, nullable, required — The cycle at whose end the subscription is scheduled to be cancelled, or absent when no cancellation is scheduled. Equals `currentCycle` once `cancelAtPeriodEnd` is true
  - `currentCycle` number, required — The current cycle of the subscription, starting from 1
  - `currentPeriodStart` string, date-time, required — The start date of the current billing period
  - `currentPeriodEnd` string, date-time, required — The end date of the current billing period
  - `setupInvoice` string, required — The ID of the invoice that set up the subscription
  - `setupLineItem` string, nullable, required — The ID of the line item that set up the subscription
  - `billingSettings` object, required — The billing settings for recurring charges
    - `paymentMethodType` 'card' | 'paypal' | 'applePay', required — The payment method type used for recurring billing
    - `gatewayProfile` string, required — The gateway profile used for recurring billing
    - `captureMethod` 'automatic' | 'automaticDelayed' | 'manual', required — The capture method used for recurring billing
    - `captureDelay` number, nullable, required — The capture delay in days, if applicable
  - `upcomingInvoice` object, nullable, required — The upcoming invoice details
    - `amount` number, required — Amount to be charged for the upcoming invoice.
    - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — Currency of the upcoming invoice.
    - `periodStart` string, date-time, required — Start date of the billing period.
    - `periodEnd` string, date-time, required — End date of the billing period.
    - `statementDescriptor` string, nullable, required — Statement descriptor for the upcoming invoice.
    - `comment` string, nullable, required — Comment for the upcoming invoice.
  - `customer` object, required — The customer associated with the subscription
    - `createdAt` string, date-time, required — The date and time when the entity was created.
    - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
    - `metadata` object, nullable — Metadata used by merchants to store additional information about the entity.
    - `id` string, required — The ID of the customer
    - `email` string, required — The email of the customer
    - `name` string, nullable, required — The name of the customer
    - `phoneNumber` string, nullable, required — The phone number of the customer
    - `dateOfBirth` string, date, nullable, required — The date of birth of the customer
    - `gender` 'male' | 'female' | 'other' | 'null', nullable, required — The gender of the customer
    - `restrictMit` boolean — Whether the customer is restricted from making merchant-initiated payments. Only available from the dashboard or the API using a secret key.
    - `restrictCit` boolean — Whether the customer is restricted from making customer-initiated payments. Only available from the dashboard or the API using a secret key.
    - `restrictReason` string, nullable — Reason for restricting the customer. Only available from the dashboard or the API using a secret key.
    - `isRestricted` boolean — Whether the customer has at least one restriction applied (either `restrictMit` or `restrictCit`). Only available from the dashboard or the API using a secret key.
    - `billingAddress` object, required — The billing address of the customer
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
      - `companyName` string, nullable, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postalCode` string, nullable, required
      - `country` string, nullable, required
    - `shippingAddress` object, required — The shipping address of the customer
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
      - `companyName` string, nullable, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postalCode` string, nullable, required
      - `country` string, nullable, required
  - `price` object, required — The price details of the subscription
    - `createdAt` string, date-time, required — The date and time when the entity was created.
    - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
    - `metadata` object, nullable — Metadata used by merchants to store additional information about the entity.
    - `id` string, required — ID of the price
    - `type` 'one_time' | 'recurring', required — Type of the price
    - `active` boolean, required — Indicates if the price is currently active. Inactive prices will be hidden from the dashboard, but can still be used in the API.
    - `name` string — Name of the price. Only available from the dashboard or the API using a secret key.
    - `amount` number, required — Amount of the price in minor units (e.g., cents)
    - `quantity` number, required — Number of units this price represents. The `amount` covers all of them, so a line item referencing this price gets this quantity at a per-unit amount of `amount / quantity`.
    - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — Currency of the price
    - `product` object — The product that this price represents. Only available from the dashboard or the API using a secret key.
      - `createdAt` string, date-time, required — The date and time when the entity was created.
      - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
      - `metadata` object, nullable, required — Metadata used by merchants to store additional information about the entity.
      - `id` string, required — ID of the product
      - `active` boolean, required — Indicates if the product is currently active. Inactive products will be hidden from the dashboard, but can still be used in the API.
      - `name` string, required — Name of the product. Only available from the dashboard or the API using a secret key.
      - `description` string, nullable, required — Description of the product. Only available from the dashboard or the API using a secret key.
      - `statementDescriptor` string, nullable, required — Statement descriptor for the product that will be used in the bank statement
      - `category` 'digital' | 'physical' | 'null', nullable, required — Category of the product, sent to the payment provider so the VAT split between digital services and physical goods can be reconstructed from the provider reports. Plays no part in fulfillment. Only available from the dashboard or the API using a secret key.
      - `shippable` boolean, required — Whether the product takes part in Order Management: a payment for one of its prices becomes an order item. Only available from the dashboard or the API using a secret key.
      - `sku` string, nullable, required — Stock Keeping Unit the warehouse ships this product under, used on the 3PL manifest. For a shippable product it decides whether the resulting order item physically ships: an item without one is kept on the order but never fulfilled. Null when the product has none. Only available from the dashboard or the API using a secret key.
    - `billingSchedule` object, nullable — Deprecated: Use recurringSchedule instead. Billing schedule for `recurring` prices. Only available from the dashboard or the API using a secret key.
      - `createdAt` string, date-time, required — The date and time when the entity was created.
      - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
      - `metadata` object, nullable, required — Metadata used by merchants to store additional information about the entity.
      - `id` string, required — ID of the billing schedule
      - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — Currency of the billing schedule
      - `cycleDefinitions` object[], required
        - `createdAt` string, date-time, required — The date and time when the entity was created.
        - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
        - `metadata` object, nullable, required — Metadata used by merchants to store additional information about the entity.
        - `position` number, required — Position of the billing cycle in the schedule. Used for ordering.
        - `amount` number, required — Amount to be charged for this billing cycle in minor units (e.g., cents)
        - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — Currency of the billing cycle
        - `intervalUnit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required — Unit of time for the billing cycle interval
        - `intervalValue` number, required — Value of the billing cycle interval
    - `recurringSchedule` object, nullable — Recurring schedule for recurring prices. Only available from the dashboard or the API using a secret key.
      - `intervalUnit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required — Recurring interval unit
      - `intervalCount` number, required — Recurring interval count
      - `trial` object, nullable, required — Trial schedule details when present
        - `intervalUnit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required — Trial interval unit
        - `intervalCount` number, required — Trial interval count
        - `amount` number, required — Initial setup/trial payment amount in minor units. This is the amount charged during the first billing cycle before the regular recurring amount takes effect.
  - `invoices` object[], required — The list of invoices associated with the subscription
    - `createdAt` string, date-time, required — The date and time when the entity was created.
    - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
    - `metadata` object, nullable — Metadata used by merchants to store additional information about the entity.
    - `id` string, required — The ID of the invoice
    - `status` 'open' | 'paid' | 'voided', required — The status of the invoice
    - `voidedReason` string, nullable, required — The reason for voiding the invoice
    - `comment` string, nullable, required — An optional comment for the invoice
    - `amount` number, required — The intended amount to pay for the invoice. The actual amount paid can differ if retrying with a percentage discount, in which case the actual amount paid can be found in `payment.amount`
    - `currency` 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk', required — The currency of the amount to be charged
    - `type` 'setup' | 'recurring', required — Indicates whether the invoice is the one that sets up the subscription, or a recurring one
    - `number` string, required — Sequential, unique, and human-readable number of the invoice
    - `subscription` string, nullable, required — The ID of the subscription associated with this invoice
    - `customer` object, required — The customer associated with this invoice
      - `createdAt` string, date-time, required — The date and time when the entity was created.
      - `updatedAt` string, date-time, nullable, required — The date and time when the entity was last updated.
      - `metadata` object, nullable — Metadata used by merchants to store additional information about the entity.
      - `id` string, required — The ID of the customer
      - `email` string, required — The email of the customer
      - `name` string, nullable, required — The name of the customer
      - `phoneNumber` string, nullable, required — The phone number of the customer
      - `dateOfBirth` string, date, nullable, required — The date of birth of the customer
      - `gender` 'male' | 'female' | 'other' | 'null', nullable, required — The gender of the customer
      - `restrictMit` boolean — Whether the customer is restricted from making merchant-initiated payments. Only available from the dashboard or the API using a secret key.
      - `restrictCit` boolean — Whether the customer is restricted from making customer-initiated payments. Only available from the dashboard or the API using a secret key.
      - `restrictReason` string, nullable — Reason for restricting the customer. Only available from the dashboard or the API using a secret key.
      - `isRestricted` boolean — Whether the customer has at least one restriction applied (either `restrictMit` or `restrictCit`). Only available from the dashboard or the API using a secret key.

## Other responses

- `202` — The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.
- `400` — The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it; or `payment_error` when the payment was refused by the issuer or processor.
- `401` — No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403` — The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `404` — No resource exists with the requested identifier. `type` is `not_found_error`.
- `409` — `type` is `conflict_error`. The supplied `X-Idempotency-Key` was already used with a different request body (`code` is `idempotency_conflict`, and retrying will not help), or the resource is being modified by another in-flight request (`code` is `resource_locked`, and retrying with backoff will).
- `429` — Too many requests. The rate limit is applied per client across all operations. `type` is `rate_limit_error`.
- `500` — The request could not be completed because of an unexpected error. `type` is `api_error`.
- `504` — The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

---

[API](https://skmtc.dev/odus/apis/odus-orchestration-api.md) · [All operations](https://skmtc.dev/odus/apis/odus-orchestration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/odus/odus-orchestration-api/revisions/d5fdcba31576/schema)