--- title: "Resume a subscription" method: POST path: "/api/v1/subscriptions/{id}/resume" tags: ["Subscriptions"] --- # Resume a subscription `POST /api/v1/subscriptions/{id}/resume` Resume a subscription. It resumes the subscription that is scheduled be cancel at the end of the period. ## Path parameters - `id` string, required ## Response `200` - SubscriptionDto - `id` string, required - `createdAt` string, date-time - `updatedAt` string, date-time - `organizationId` string, uuid - `tags` string[] - `clientReferenceId` string - `currency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu', required - `collectionMethod` 'superfluid' | 'charge_automatically' | 'send_invoice' - `interval` 'day' | 'week' | 'month' | 'year', required - `intervalCount` number - `paymentMethodTypes` PaymentMethodType[] - `status` 'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused', required - `description` string - `metadata` object - `defaultPaymentMethodId` string, uuid - `defaultPaymentMethod` PaymentMethodDto - `id` string, required - `createdAt` string, date-time - `updatedAt` string, date-time - `assetId` string, uuid, required - `asset` AssetDto, required - `id` string, required — Asset id - `name` string, required — Asset name - `chainId` number, required — Asset chain id - `address` string, required — Asset address on chain - `currency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu' | 'usd' | 'inr', required - `symbol` string, required — Asset symbol - `decimals` number, required — Asset decimals in which it is represented on chain - `coingeckoId` string — Asset coingecko id - `superToken` SuperTokenDto - `address` string, required — SuperToken's address - `decimals` number, required - `symbol` string, required — SuperToken's symbol - `isEIP5827Supported` boolean, required — Is EIP5827 supported - `type` 'superfluid' | 'wallet' | 'allowance_based_recurring' | 'stripe' | 'binance_pay', required - `accountAddress` string - `billingDetails` FullAddressDetailDto - `name` string — The name - `email` string — The email - `phone` string — The phone - `organizationName` string — The organization name - `address` AddressDetailDto - `line1` string - `line2` string - `city` string - `state` string - `postalCode` string - `country` string - `customerId` string, uuid - `options` object - `customerId` string, uuid - `customer` CustomerDto - `name` string — The name - `email` string — The email - `phone` string — The phone - `organizationName` string — The organization name - `address` AddressDetailDto - `line1` string - `line2` string - `city` string - `state` string - `postalCode` string - `country` string - `id` string, uuid, required — Customer's id - `createdAt` string, date-time — Customer's created at - `updatedAt` string, date-time — Customer's updated at - `customerReferenceId` string — Customer's reference id - `shipping` FullAddressDetailDto - `name` string — The name - `email` string — The email - `phone` string — The phone - `organizationName` string — The organization name - `address` AddressDetailDto - `line1` string - `line2` string - `city` string - `state` string - `postalCode` string - `country` string - `taxIds` TaxIdsDto - `object` string - `data` TaxIdDto[] - `id` string, required - `createdAt` string, date-time - `updatedAt` string, date-time - `name` string - `value` string - `country` string - `customerId` string, uuid, required - `visibility` string - `metadata` object — Customer's metadata - `customerNumber` string, required — Customer number assigned by the system - `startDate` string, date-time - `endedAt` string, date-time - `cancelAt` string, date-time - `canceledAt` string, date-time - `lineItems` SubscriptionPriceItemsDto, required - `object` string - `data` SubscriptionPriceItemDto[] - `description` string - `quantity` number - `price` PublicPriceDto, required - `id` string, required - `createdAt` string, date-time - `updatedAt` string, date-time - `billingScheme` 'per_unit' - `currency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu', required - `productId` string, uuid, required — Product's id - `interval` 'day' | 'week' | 'month' | 'year' - `intervalCount` number — It is used to determine the frequency at which the subscription is billed. Only required for subscriptions - `isActive` boolean — Whether the price is currently active - `usageType` 'licensed' - `type` 'one_time' | 'recurring' | 'streaming', required - `unitAmount` integer — The unit amount in 8 decimals, represented as a whole integer. If not provided, the unit amount will be calculated from unit_amount_decimal. - `unitAmountDecimal` string - `customUnitMax` integer — The maximum amount that can be billed per unit for this price. Only if unit amount is not provided - `customUnitMin` integer — The minimum amount that can be billed per unit for this price. Only if unit amount is not provided - `customPreset` integer — The default amount to fill in the amount field for this price on checkout. Only if unit amount is not provided - `customUnitAmountSuggestions` string[] — Amount suggestions for this price. Only if unit amount is not provided - `product` PublicProductDto, required - `id` string, required - `createdAt` string, date-time - `updatedAt` string, date-time - `name` string, required — The name of the product. Displayed on the checkout page - `description` string — The description of the product. Displayed on the checkout page - `isActive` boolean — Whether the product is currently active - `images` string[] — The url of product images. Displayed on the checkout page - `publicImages` string[] — Product images with absolute public url - `unitLabel` string — The label of the unit of the product. Displayed on the checkout page - `url` string — The url of the product - `defaultPriceId` string, uuid — Product's default price id - `metadata` object — The metadata of the product - `visibility` string - `metadata` object — A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format. - `visibility` string - `taxRates` LineTaxRateDto[] - `id` string, required - `name` string, required — The name of the tax rate. - `description` string — The description of the tax rate. - `country` string — The country of the tax rate. - `percentage` number, required — Percent that will be added to subtotal as a tax. - `type` 'exclusive' | 'inclusive', required - `isDefault` boolean, required - `amountTotal` integer - `amountSubtotal` integer - `amountTax` integer - `currency` 'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu' | 'usd' | 'inr' - `cancellationReason` string - `currentPeriodEnd` string, date-time - `currentPeriodStart` string, date-time - `cancelAtPeriodEnd` boolean ## Other responses - `500` --- [API](https://skmtc.net/copperx/apis/copperx-api-2.md) · [All operations](https://skmtc.net/copperx/apis/copperx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/copperx/copperx-api-2/versions/c0bfbc37fb98/schema)