Backend API
Delete a subscription permanently.
Arguments
idobjectIdrequired
The id of the subscription to delete.
DELETE/subscriptions/:id
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.delete('/subscriptions/60f199509111e700000000c7');
The subscription model
{
"id": "60f199509111e700000000c7",
"account_id": "60f199509111e700000000c8",
"product_id": "60f199509111e700000000c9",
"active": true,
"cancel_at_end": false,
"cancel_reason": null,
"canceled": false,
"currency": "USD",
"date_canceled": null,
"date_created": "2021-07-16T14:36:00.483Z",
"date_payment_expiring": "2031-01-01T08:00:00.000Z",
"date_payment_failed": null,
"date_payment_retry": null,
"date_period_end": "2019-03-24T04:28:12.962Z",
"date_period_start": "2019-02-24T04:28:12.962Z",
"date_trial_end": "2019-02-24T04:28:12.962Z",
"date_trial_start": "2019-01-24T04:28:12.962Z",
"date_updated": "2021-07-16T14:36:00.483Z",
"discount_total": 0,
"discounts": null,
"grand_total": 148.8946,
"interval": "monthly",
"interval_count": 1,
"invoice_total": 99,
"item_discount": 0,
"item_tax": 0,
"item_total": 49.8946,
"items": [
{
"id": "5ca537326a0ec32a521139dd",
"date_created": "2019-03-24T22:56:33.467Z",
"description": "Remaining time on Example Subscription",
"proration": true,
"quantity": 1,
"price": 49.8946,
"price_total": 49.8946,
"recurring_price": 0,
"recurring_price_total": 0,
"discount_total": 0,
"discount_each": 0,
"recurring_discount_total": 0,
"recurring_discount_each": 0,
"tax_total": 0,
"tax_each": 0,
"recurring_tax_total": 0,
"recurring_tax_each": 0
}
],
"notes": null,
"options": [
{
"id": "5becb84fac207653a4816ee5",
"name": "Plan",
"value": "Monthly"
}
],
"order_id": "60f199509111e7000000009d",
"order_item_id": "60f199509111e7000000009e",
"paid": true,
"payment_balance": 0,
"payment_total": 99,
"price": 99,
"price_total": 99,
"product_discount_each": 0,
"product_discount_total": 0,
"product_discounts": null,
"product_tax_each": 0,
"product_tax_total": 0,
"product_taxes": null,
"quantity": 1,
"recurring_discount_total": 0,
"recurring_item_discount": 0,
"recurring_item_tax": 0,
"recurring_item_total": 0,
"recurring_tax_included_total": 0,
"recurring_tax_total": 0,
"recurring_total": 99,
"refund_total": 0,
"status": "active",
"sub_total": 148.8946,
"tax_included_total": 0,
"tax_total": 0,
"taxes": null,
"trial": false,
"trial_days": 14,
"unpaid": false,
"variant_id": "60f199509111e7000000009f"
}