Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Pause a subscription

Pauses a subscription with the given subscription_id.

The subscription pauses on the next billing cycle date and transitions to a "paused" status instead of charging the customer.

post/subscriptions/{subscription_id}/pause

Path parameters

subscription_idstring required
Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier for the subscription.

Request body

pausePeriodCountinteger required

Number of periods the subscription should be paused.

Example request

{
  "pausePeriodCount": 2
}

Response

OK

idstring

Unique identifier for the subscription.

quotestring nullable

Quote associated with the subscription, if any.

subscriptionstring

Unique identifier for the subscription.

activeboolean

Indicates if the subscription is active.

statestring

Current state of the subscription (e.g., active, paused).

isSubscriptionEligibleForPauseByBuyerboolean

Indicates if the subscription can be paused by the buyer.

isPauseScheduledboolean

Indicates if a pause is scheduled for the subscription.

changedinteger

Timestamp of the last change in milliseconds.

changedValueinteger

Value of the last change in milliseconds.

changedInSecondsinteger

Timestamp of the last change in seconds.

changedDisplaystring

Formatted display of the last change date.

changedDisplayISO8601string date

ISO 8601 formatted last change date.

changedDisplayEmailEnhancementsstring

Email-friendly formatted last change date.

changedDisplayEmailEnhancementsWithTimestring

Email-friendly formatted last change date with time.

liveboolean

Indicates if the subscription is live or in test mode.

currencystring

Currency code of the subscription.

accountstring

Identifier for the account associated with the subscription.

productstring

Identifier for the subscription product.

skustring nullable

SKU of the subscription product, if available.

displaystring

Display name of the subscription product.

quantityinteger

Quantity of the subscription product.

adhocboolean

Indicates if the subscription is ad hoc.

autoRenewboolean

Indicates if the subscription auto-renews.

pricenumber float

Price of the subscription.

priceDisplaystring

Formatted price of the subscription.

priceInPayoutCurrencynumber float

Price in the payout currency.

priceInPayoutCurrencyDisplaystring

Formatted price in the payout currency.

discountnumber float

Discount applied to the subscription.

discountDisplaystring

Formatted display of the discount.

discountInPayoutCurrencynumber float

Discount in the payout currency.

discountInPayoutCurrencyDisplaystring

Formatted discount in the payout currency.

subtotalnumber float

Subtotal of the subscription.

subtotalDisplaystring

Formatted display of the subtotal.

subtotalInPayoutCurrencynumber float

Subtotal in the payout currency.

subtotalInPayoutCurrencyDisplaystring

Formatted subtotal in the payout currency.

nextinteger

Timestamp for the next billing date (in milliseconds).

nextValueinteger

Value of the next billing date in milliseconds.

nextInSecondsinteger

Timestamp for the next billing date in seconds.

nextDisplaystring

Formatted display of the next billing date.

nextDisplayISO8601string date

ISO 8601 formatted next billing date.

endstring nullable

End date of the subscription, if applicable.

endValuestring nullable

Value of the end date of the subscription, if applicable.

endInSecondsinteger nullable

End date of the subscription in seconds.

endDisplaystring nullable

Formatted display of the end date of the subscription.

endDisplayISO8601string date nullable

ISO 8601 formatted end date of the subscription.

canceledDatestring nullable

Date the subscription was canceled, if applicable.

canceledDateValuestring nullable

Value of the canceled date of the subscription.

canceledDateInSecondsinteger nullable

Timestamp of the canceled date in seconds.

canceledDateDisplaystring nullable

Formatted display of the canceled date.

canceledDateDisplayISO8601string date nullable

ISO 8601 formatted canceled date.

deactivationDatestring nullable

Date the subscription was deactivated, if applicable.

deactivationDateValuestring nullable

Value of the deactivation date of the subscription.

deactivationDateInSecondsinteger nullable

Deactivation date of the subscription in seconds.

deactivationDateDisplaystring nullable

Formatted display of the deactivation date.

deactivationDateDisplayISO8601string date nullable

ISO 8601 formatted deactivation date.

sequenceinteger

Sequence number of the subscription's billing cycle.

periodsstring nullable

Total number of billing periods, if applicable.

remainingPeriodsstring nullable

Remaining billing periods, if applicable.

begininteger

Timestamp of the subscription start date in milliseconds.

beginValueinteger

Value of the subscription start date in milliseconds.

beginInSecondsinteger

Subscription start date in seconds.

beginDisplaystring

Formatted display of the subscription start date.

beginDisplayISO8601string date

ISO 8601 formatted subscription start date.

beginDisplayEmailEnhancementsstring

Email-friendly formatted subscription start date.

beginDisplayEmailEnhancementsWithTimestring

Email-friendly formatted subscription start date with time.

nextDisplayEmailEnhancementsstring

Email-friendly formatted next billing date.

nextDisplayEmailEnhancementsWithTimestring

Email-friendly formatted next billing date with time.

intervalUnitstring

Unit of the billing interval (e.g., year, month).

intervalUnitAbbreviationstring

Abbreviation for the billing interval unit.

intervalLengthinteger

Length of the billing interval.

intervalLengthGtOneboolean

Indicates if the interval length is greater than one.

nextChargeCurrencystring

Currency for the next charge.

nextChargeDateinteger

Timestamp for the next charge date in milliseconds.

nextChargeDateValueinteger

Value of the next charge date in milliseconds.

nextChargeDateInSecondsinteger

Next charge date in seconds.

nextChargeDateDisplaystring

Formatted display of the next charge date.

nextChargeDateDisplayISO8601string date

ISO 8601 formatted next charge date.

nextChargePreTaxnumber float

Pre-tax amount of the next charge.

nextChargePreTaxDisplaystring

Formatted pre-tax amount of the next charge.

nextChargePreTaxInPayoutCurrencynumber float

Pre-tax amount of the next charge in the payout currency.

nextChargePreTaxInPayoutCurrencyDisplaystring

Formatted pre-tax amount in the payout currency.

nextChargeTotalnumber float

Total amount of the next charge.

nextChargeTotalDisplaystring

Formatted total amount of the next charge.

nextChargeTotalInPayoutCurrencynumber float

Total amount in the payout currency.

nextChargeTotalInPayoutCurrencyDisplaystring

Formatted total amount in the payout currency.

nextNotificationTypestring

Type of the next notification (e.g., PAYMENT_REMINDER).

nextNotificationDateinteger

Timestamp for the next notification date in milliseconds.

nextNotificationDateValueinteger

Value of the next notification date in milliseconds.

nextNotificationDateInSecondsinteger

Next notification date in seconds.

nextNotificationDateDisplaystring

Formatted display of the next notification date.

nextNotificationDateDisplayISO8601string date

ISO 8601 formatted next notification date.

pauseDateinteger

Timestamp of the pause date in milliseconds.

pauseDateValueinteger

Value of the pause date in milliseconds.

pauseDateInSecondsinteger

Pause date in seconds.

pauseDateDisplaystring

Formatted display of the pause date.

pauseDateDisplayISO8601string date

ISO 8601 formatted pause date.

resumeDateinteger

Timestamp of the resume date in milliseconds.

resumeDateValueinteger

Value of the resume date in milliseconds.

resumeDateInSecondsinteger

Resume date in seconds.

resumeDateDisplaystring

Formatted display of the resume date.

resumeDateDisplayISO8601string date

ISO 8601 formatted resume date.

fulfillmentsobject

Fulfillment details for the subscription.

initialOrderIdstring

Unique identifier for the initial order associated with the subscription.

initialOrderReferencestring

Reference number for the initial order associated with the subscription.

actionstring

Action performed on the subscription.

resultstring

Result of the action performed, indicating success or failure.

Example response

{
  "id": "aBCDE12fGH3iJkL4mNOpqr",
  "subscription": "aBCDE12fGH3iJkL4mNOpqr",
  "active": true,
  "state": "active",
  "isPauseScheduled": true,
  "changed": 1737753214722,
  "changedValue": 1737753214722,
  "changedInSeconds": 1737753214,
  "changedDisplay": "1/24/25",
  "changedDisplayISO8601": "2025-01-24",
  "changedDisplayEmailEnhancements": "Jan 01, 2025",
  "changedDisplayEmailEnhancementsWithTime": "Jan 01, 2025 09:13:34 PM",
  "currency": "USD",
  "account": "abCdE1FGH2Hij3KLMnOpqR",
  "product": "furious-falcon-annual-subscription",
  "display": "Furious Falcon Annual Subscription",
  "quantity": 1,
  "autoRenew": true,
  "price": 10,
  "priceDisplay": "$10.00",
  "priceInPayoutCurrency": 10,
  "priceInPayoutCurrencyDisplay": "$10.00",
  "discountDisplay": "$0.00",
  "discountInPayoutCurrencyDisplay": "$0.00",
  "subtotal": 10,
  "subtotalDisplay": "$10.00",
  "subtotalInPayoutCurrency": 10,
  "subtotalInPayoutCurrencyDisplay": "$10.00",
  "next": 1825977600000,
  "nextValue": 1825977600000,
  "nextInSeconds": 1825977600,
  "nextDisplay": "11/12/27",
  "nextDisplayISO8601": "2027-11-12",
  "sequence": 1,
  "begin": 1731383443568,
  "beginValue": 1731383443568,
  "beginInSeconds": 1731383443,
  "beginDisplay": "11/12/24",
  "beginDisplayISO8601": "2025-01-01",
  "beginDisplayEmailEnhancements": "Jan 01, 2025",
  "beginDisplayEmailEnhancementsWithTime": "Jan 01, 2025 03:50:43 AM",
  "nextDisplayEmailEnhancements": "Jan 01, 2027",
  "nextDisplayEmailEnhancementsWithTime": "Jan 01, 2027 12:00:00 AM",
  "intervalUnit": "year",
  "intervalUnitAbbreviation": "yr",
  "intervalLength": 1,
  "nextChargeCurrency": "USD",
  "nextChargeDate": 1825977600000,
  "nextChargeDateValue": 1825977600000,
  "nextChargeDateInSeconds": 1825977600,
  "nextChargeDateDisplay": "11/12/27",
  "nextChargeDateDisplayISO8601": "2027-11-12",
  "nextChargePreTax": 10,
  "nextChargePreTaxDisplay": "$10.00",
  "nextChargePreTaxInPayoutCurrency": 10,
  "nextChargePreTaxInPayoutCurrencyDisplay": "$10.00",
  "nextChargeTotal": 10,
  "nextChargeTotalDisplay": "$10.00",
  "nextChargeTotalInPayoutCurrency": 10,
  "nextChargeTotalInPayoutCurrencyDisplay": "$10.00",
  "nextNotificationType": "PAYMENT_REMINDER",
  "nextNotificationDate": 1825372800000,
  "nextNotificationDateValue": 1825372800000,
  "nextNotificationDateInSeconds": 1825372800,
  "nextNotificationDateDisplay": "11/5/27",
  "nextNotificationDateDisplayISO8601": "2027-11-05",
  "paymentReminder": {
    "intervalUnit": "week",
    "intervalLength": 1
  },
  "paymentOverdue": {
    "intervalUnit": "week",
    "intervalLength": 1,
    "total": 4
  },
  "cancellationSetting": {
    "cancellation": "AFTER_LAST_NOTIFICATION",
    "intervalUnit": "week",
    "intervalLength": 1
  },
  "pauseDate": 1762905600000,
  "pauseDateValue": 1762905600000,
  "pauseDateInSeconds": 1762905600,
  "pauseDateDisplay": "11/12/25",
  "pauseDateDisplayISO8601": "2025-11-12",
  "resumeDate": 1825977600000,
  "resumeDateValue": 1825977600000,
  "resumeDateInSeconds": 1825977600,
  "resumeDateDisplay": "11/12/27",
  "resumeDateDisplayISO8601": "2027-11-12",
  "instructions": [
    {
      "product": "furious-falcon-annual-subscription",
      "type": "regular",
      "isNotTrial": true,
      "periodStartDate": 1731369600000,
      "periodStartDateValue": 1731369600000,
      "periodStartDateInSeconds": 1731369600,
      "periodStartDateDisplay": "11/12/24",
      "periodStartDateDisplayISO8601": "2025-01-01",
      "intervalUnit": "year",
      "intervalLength": 1,
      "discountPercentDisplay": "0%",
      "discountTotalDisplay": "$0.00",
      "discountTotalInPayoutCurrencyDisplay": "$0.00",
      "unitDiscountDisplay": "$0.00",
      "unitDiscountInPayoutCurrencyDisplay": "$0.00",
      "price": 10,
      "priceDisplay": "$10.00",
      "priceInPayoutCurrency": 10,
      "priceInPayoutCurrencyDisplay": "$10.00",
      "priceTotal": 10,
      "priceTotalDisplay": "$10.00",
      "priceTotalInPayoutCurrency": 10,
      "priceTotalInPayoutCurrencyDisplay": "$10.00",
      "unitPrice": 10,
      "unitPriceDisplay": "$10.00",
      "unitPriceInPayoutCurrency": 10,
      "unitPriceInPayoutCurrencyDisplay": "$10.00",
      "total": 10,
      "totalDisplay": "$10.00",
      "totalInPayoutCurrency": 10,
      "totalInPayoutCurrencyDisplay": "$10.00",
      "totalWithTaxes": 10,
      "totalWithTaxesDisplay": "$10.00",
      "totalWithTaxesInPayoutCurrency": 10,
      "totalWithTaxesInPayoutCurrencyDisplay": "$10.00"
    }
  ],
  "initialOrderId": "9_fopjeBRBuCgCz0Nm2VXw",
  "initialOrderReference": "NKO241112-7593-98143",
  "action": "subscriptions.pause.get",
  "result": "success"
}