# Subscription order pause revoked

Endpoint: POST subscription-pause-revoked
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `subscriptionId` (string)
    ID of the order.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `subscriptionPauseId` (string)
    ID of the subscription pause.
    Example: "sub_pau_01H085J3ZR1WKD120D73D7N4C9"

  - `eventType` (string)
    Type of event that triggered the webhook.
    Enum: "subscription-pause-created", "subscription-pause-modified", "subscription-pause-revoked", "subscription-paused", "subscription-resumed"

  - `_embedded` (object)
    Embedded objects related to the subscription pause event.

  - `_embedded.subscription` (object) — one of (discriminator: orderType):
    Subscription details.
    - subscription-order:
      - `orderType` (string, required)
        Specifies the type of order.
An order may be a subscription or a one-time purchase.

> Note: The order type cannot be changed after creation.
        Enum: "subscription-order"
      - `customerId` (string, required)
        ID of the customer resource.
      - `trial` (object)
        Details of the trial.
To use plan defaults, omit the trial key or set this value to null.
      - `trial.enabled` (boolean)
        Specifies if there is a trial for this subscription.
Plans without trial prices are free trials.
      - `trial.endTime` (string,null)
        Time and date when the trial ends.
If a trial is enabled on this subscription, a value must be provided.

If the specified trial end time is in the past, the current time is used.
      - `isTrialOnly` (boolean)
        Specifies if a subscription ends after a trial period.
If this value is true, recurring settings are ignored.
      - `invoiceTimeShift` (object,null)
        Shifts issue time and due time of invoices for this subscription.

This setting overrides plan settings.
To use plan settings, set this value to null.

To use multiple plans in one subscription,
all plans must have the same billing period,
this property enables the customer to subscribe to different plans.
      - `invoiceTimeShift.issueTimeShift` (object)
        Calculation instruction of the billing time.

This is used in conjunction with the service period anchor to calculate
the time at which the invoice is issued. For more information, see
[Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
      - `invoiceTimeShift.issueTimeShift.chronology` (string, required)
        Sequential order of the billing time relative to the start of the service period.
        Enum: "before"
      - `invoiceTimeShift.issueTimeShift.duration` (integer, required)
        Amount of time by which to move the invoice issue time or date.
      - `invoiceTimeShift.issueTimeShift.unit` (any, required)
        Unit of time.
      - `invoiceTimeShift.dueTimeShift` (object)
        Calculation instruction of the invoice due time.

This is used in conjunction with the billing anchor to calculate when
an invoice is due for payment. For more information, see
[Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).

The sequential order of due time shift is always after the due date.
      - `invoiceTimeShift.dueTimeShift.duration` (integer, required)
        Amount of time by which to move the invoice due time or date.
      - `invoiceTimeShift.dueTimeShift.unit` (any, required)
        Unit of time.
      - `recurringInterval` (object,null)
        Recurring interval to override plan settings.
To use plan settings, set this value to null.

To use multiple plans in one subscription,
all plans must have the same recurring period length.
      - `recurringInterval.periodAnchorInstruction` (object,null) — one of (discriminator: method):
        Instruction for calculating the service period anchor.

The service period anchor is used, in conjunction with the subscription
start time, to calculate when the service period starts and ends.
        - day-of-month:
          - `method` (string, required)
            Enum: "day-of-month"
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-of-week:
          - `method` (string, required)
            Enum: "day-of-week"
          - `day` (string, required)
            Day of the week when the event occurs.
            Enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"
          - `week` (string, required)
            Enum: "next", "first-in-month", "last-in-month"
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-and-month-of-year:
          - `method` (string, required)
            Enum: "day-and-month-of-year"
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `month` (integer, required)
            Month of the year in which the event occurs.
          - `time` (string)
            Extended ISO-8601 format of time.
      - `autopay` (boolean)
        Specifies if payment attempts are made automatically.
If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at paymentInstrumentId,
or the default payment instrument on the subscription.
      - `startTime` (string,null)
        Date and time when the subscription starts.
If this value is null, the current time is used.
This value cannot be more than one service period in the past.
      - `renewalTime` (string,null)
        Date and time when the subscription renews.
      - `paymentInstrumentId` (string,null)
        ID of the payment instrument to use for autopay.
If this value is not provided, or if the payment instrument is inactive,
the customer's default payment instrument is used.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
      - `websiteId` (string, required)
        ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

> Note: The ID of the website cannot be changed after creation.
        Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
      - `items` (array, required)
        Details of items in the order.
      - `items.quantity` (integer)
        Number of product units in the specified plan.
      - `items.quantityFilled` (number)
        Number of filled product units.
        Example: 5.125
      - `items.plan` (any, required)
        - `id` (string, required)
          ID of the plan.
      - `items.usageLimits` (any)
        - `softLimit` (object)
          Defines thresholds for notification purposes.
For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
When the reported usage reaches 75%, 90%, and 100% of the configured limit a specific event is triggered.
To notify the customer, a webhook and notification can be configured for this event.
This field is useful for accounting and customer success purposes.
The usage of metered billing plans can still be reported if the soft limit is reached.
        - `softLimit.quantity` (integer)
          Usage limit quantity.
        - `softLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `hardLimit` (object)
          Defines a limit where the customer can no longer use the service.
Hard limits are used in addition to soft limits.
When a soft limit is reached,
a customer may receive a notification
but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
When the reported usage reaches the configured limit,
a specific event is triggered.
To notify the customer in the merchant system,
or block a service,
a webhook and notification can be configured for this event.
When the total usage reaches the hard limit quantity,
or amount values,
metered billing plan usages can no longer be reported.
        - `hardLimit.quantity` (integer)
          Usage limit quantity.
        - `hardLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `trialLimit` (any)
          Defines a usage cap during the trial period of a subscription.
This limit is enforced only while the subscription is in its trial phase.
When the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered.
To notify the customer or restrict access to the service, a webhook and notification can be configured for this event.
Once the trial limit is reached, additional usage cannot be reported unless the trial ends.
          Example: 20.725
      - `items.usageStatus` (any)
        - `isSoftLimitReached` (boolean)
          Specifies if the soft limit has been reached.
        - `isHardLimitReached` (boolean)
          Specifies if the hard limit has been reached.
        - `isTrialLimitReached` (boolean)
          Specifies if the trial limit has been reached.
      - `items.excludeFromMrr` (boolean)
        Specifies if this item should be excluded from monthly recurring revenue calculations.
      - `items.planId` (string)
        ID of the plan.
        Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
      - `deliveryAddress` (any)
        Delivery address of the order.
        - `firstName` (string,null)
          Contact's first name.
          Example: "Benjamin"
        - `lastName` (string,null)
          Contact's last name.
          Example: "Franklin"
        - `organization` (string,null)
          Contact's organization.
          Example: "Rebilly"
        - `address` (string,null)
          First line of the contact's street address.
          Example: "36 Craven St"
        - `address2` (string,null)
          Second line of the contact's street address.
        - `city` (string,null)
          Contact's city of residence.
          Example: "Austin"
        - `region` (string,null)
          Contact's region of residence.
          Example: "Texas"
        - `country` (string,null)
          Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
          Example: "GB"
        - `postalCode` (string,null)
          Contact's postal code.
          Example: "WC2N 5NF"
        - `phoneNumbers` (array)
          List of phone numbers associated with the contact.
        - `phoneNumbers.label` (string, required)
          Phone number label or name.
          Example: "main"
        - `phoneNumbers.value` (string, required)
          Phone number value.
          Example: "1-512-777-0269"
        - `phoneNumbers.primary` (boolean)
          Specifies if the phone number is the contact's primary phone number.
          Example: true
        - `emails` (array)
          List of email addresses associated with the contact.
        - `emails.label` (string, required)
          Email label or name.
          Example: "main"
        - `emails.value` (string, required)
          Email address value.
          Example: "rebilly@example.com"
        - `emails.primary` (boolean)
          Specifies if the email address is the contact's primary email address.
          Example: true
        - `dob` (string,null)
          Contact's date of birth in ISO-8601 YYYY-MM-DD format.
          Example: "1980-04-01"
        - `jobTitle` (string,null)
          Contact's job title.
          Example: "CEO"
      - `billingAddress` (any)
        Billing address of the order.
        - `firstName` (string,null)
          Contact's first name.
          Example: "Benjamin"
        - `lastName` (string,null)
          Contact's last name.
          Example: "Franklin"
        - `organization` (string,null)
          Contact's organization.
          Example: "Rebilly"
        - `address` (string,null)
          First line of the contact's street address.
          Example: "36 Craven St"
        - `address2` (string,null)
          Second line of the contact's street address.
        - `city` (string,null)
          Contact's city of residence.
          Example: "Austin"
        - `region` (string,null)
          Contact's region of residence.
          Example: "Texas"
        - `country` (string,null)
          Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
          Example: "GB"
        - `postalCode` (string,null)
          Contact's postal code.
          Example: "WC2N 5NF"
        - `phoneNumbers` (array)
          List of phone numbers associated with the contact.
        - `phoneNumbers.label` (string, required)
          Phone number label or name.
          Example: "main"
        - `phoneNumbers.value` (string, required)
          Phone number value.
          Example: "1-512-777-0269"
        - `phoneNumbers.primary` (boolean)
          Specifies if the phone number is the contact's primary phone number.
          Example: true
        - `emails` (array)
          List of email addresses associated with the contact.
        - `emails.label` (string, required)
          Email label or name.
          Example: "main"
        - `emails.value` (string, required)
          Email address value.
          Example: "rebilly@example.com"
        - `emails.primary` (boolean)
          Specifies if the email address is the contact's primary email address.
          Example: true
        - `dob` (string,null)
          Contact's date of birth in ISO-8601 YYYY-MM-DD format.
          Example: "1980-04-01"
        - `jobTitle` (string,null)
          Contact's job title.
          Example: "CEO"
      - `abandonTime` (string,null)
        Date and time when the pending order is automatically abandoned.
If this value is not passed during order creation,
a [pending order TTL](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl) setting is used to calculate the value.
      - `delinquencyPeriod` (string,null)
        Length of time, in ISO-8601 durations format,
which is added to the due time of the order when setting the delinquency time for all related invoices.
When the delinquency time of an invoice is reached, the order is automatically canceled.

{% admonition type="warning" %}
- If the delinquencyPeriod value is null, the order does not change state and remains active.
You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
- If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the delinquencyTime parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
{% /admonition %}

If this value is not passed during order creation,
an [order delinquency period](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/orderdelinquencyperiod) setting is used to calculate the value.
        Example: "P7D"
      - `couponIds` (array,null)
        List of coupons to redeem on the customer and restrict to this order.

For more information, see [Coupons](https://www.rebilly.com/docs/settings/coupons-and-discounts/).

This parameter uses the following logic:

- If this parameter is not supplied, applied coupons are not changed.
- If an empty array is supplied, all applied coupon redemptions are canceled.
- If a list of coupons is supplied, unapplied coupons in the list are applied.
  Coupons that have already been applied do not change state.
  Applied coupons that are not supplied in list are canceled.

If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued.
      - `poNumber` (string,null)
        Purchase order number displayed on the issued invoices.
        Example: "PO123456"
      - `shipping` (object) — one of (discriminator: calculator):
        Shipping settings.
        - manual:
          - `amount` (number, required)
            Shipping amount.
          - `calculator` (string, required)
            Shipping calculator.
            Enum: "manual"
        - rebilly:
          - `calculator` (string, required)
            Shipping calculator.
            Enum: "rebilly"
          - `rateId` (string,null)
            ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
            Example: "shipping-123-456"
      - `notes` (string)
        Notes for the customer displayed on the order invoice.
      - `riskMetadata` (any)
        Risk metadata.
If this value is null, this field uses risk metadata that is captured when creating the payment token.
        - `ipAddress` (string,null)
          Customer's IP address.
          Example: "93.92.91.90"
        - `fingerprint` (string,null)
          Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
          Example: "pIUt3xbgX3l9g3YDiLbx"
        - `httpHeaders` (any)
        - `browserData` (object,null)
          Browser data used for 3D Secure and risk scoring.
        - `browserData.colorDepth` (integer, required)
          Browser color depth in bits per pixel.
This value is obtained using the screen.colorDepth property.
          Example: 24
        - `browserData.isJavaEnabled` (boolean, required)
          Specifies if Java is enabled in a browser.
This value is obtained from the navigator.javaEnabled property.
        - `browserData.language` (string, required)
          Browser language settings.
This value is obtained from the navigator.language property.
          Example: "en-US"
        - `browserData.screenWidth` (integer, required)
          Width of the browser screen.
This value is obtained from the screen.width property.
          Example: 1920
        - `browserData.screenHeight` (integer, required)
          Height of the browser screen.
This value is obtained from the screen.height property.
          Example: 1080
        - `browserData.timeZoneOffset` (integer, required)
          Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the (new Date()).getTimezoneOffset() property.
          Example: 300
        - `browserData.isAdBlockEnabled` (boolean)
          Specifies if the usage of ad block has been detected in the browser.
        - `extraData` (object,null)
          Third-party data used for risk scoring.
        - `extraData.kountFraudSessionId` (string)
          Alpha-numeric fraudSessionId as provided by the Kount SDK.
          Example: "abcdefg12345abababab123456789012"
        - `extraData.payPalMerchantSessionId` (string)
          PayPal MerchantSessionID as generated by the PayPal Fraudnet SDK.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"
        - `extraData.threatMetrixSessionId` (string)
          Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
      - `customFields` (object)
        Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).
    - one-time-order:
      - `orderType` (string, required)
        Specifies the type of order.
An order may be a subscription or a one-time purchase.
        Enum: "one-time-order"
      - `customerId` (string, required)
        ID of the customer resource.
      - `websiteId` (string, required)
        ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
        Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
      - `items` (array, required)
        Details of items in the order.
      - `items.quantity` (integer)
        Number of product units in the specified plan.
      - `items.quantityFilled` (number)
        Number of filled product units.
        Example: 5.125
      - `items.plan` (any, required)
        - `id` (string, required)
          ID of the plan.
      - `items.usageLimits` (any)
        - `softLimit` (object)
          Defines thresholds for notification purposes.
For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
When the reported usage reaches 75%, 90%, and 100% of the configured limit a specific event is triggered.
To notify the customer, a webhook and notification can be configured for this event.
This field is useful for accounting and customer success purposes.
The usage of metered billing plans can still be reported if the soft limit is reached.
        - `softLimit.quantity` (integer)
          Usage limit quantity.
        - `softLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `hardLimit` (object)
          Defines a limit where the customer can no longer use the service.
Hard limits are used in addition to soft limits.
When a soft limit is reached,
a customer may receive a notification
but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
When the reported usage reaches the configured limit,
a specific event is triggered.
To notify the customer in the merchant system,
or block a service,
a webhook and notification can be configured for this event.
When the total usage reaches the hard limit quantity,
or amount values,
metered billing plan usages can no longer be reported.
        - `hardLimit.quantity` (integer)
          Usage limit quantity.
        - `hardLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `trialLimit` (any)
          Defines a usage cap during the trial period of a subscription.
This limit is enforced only while the subscription is in its trial phase.
When the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered.
To notify the customer or restrict access to the service, a webhook and notification can be configured for this event.
Once the trial limit is reached, additional usage cannot be reported unless the trial ends.
          Example: 20.725
      - `items.usageStatus` (any)
        - `isSoftLimitReached` (boolean)
          Specifies if the soft limit has been reached.
        - `isHardLimitReached` (boolean)
          Specifies if the hard limit has been reached.
        - `isTrialLimitReached` (boolean)
          Specifies if the trial limit has been reached.
      - `items.excludeFromMrr` (boolean)
        Specifies if this item should be excluded from monthly recurring revenue calculations.
      - `items.planId` (string)
        ID of the plan.
        Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
      - `deliveryAddress` (any)
        Delivery address of the order.
        - `firstName` (string,null)
          Contact's first name.
          Example: "Benjamin"
        - `lastName` (string,null)
          Contact's last name.
          Example: "Franklin"
        - `organization` (string,null)
          Contact's organization.
          Example: "Rebilly"
        - `address` (string,null)
          First line of the contact's street address.
          Example: "36 Craven St"
        - `address2` (string,null)
          Second line of the contact's street address.
        - `city` (string,null)
          Contact's city of residence.
          Example: "Austin"
        - `region` (string,null)
          Contact's region of residence.
          Example: "Texas"
        - `country` (string,null)
          Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
          Example: "GB"
        - `postalCode` (string,null)
          Contact's postal code.
          Example: "WC2N 5NF"
        - `phoneNumbers` (array)
          List of phone numbers associated with the contact.
        - `phoneNumbers.label` (string, required)
          Phone number label or name.
          Example: "main"
        - `phoneNumbers.value` (string, required)
          Phone number value.
          Example: "1-512-777-0269"
        - `phoneNumbers.primary` (boolean)
          Specifies if the phone number is the contact's primary phone number.
          Example: true
        - `emails` (array)
          List of email addresses associated with the contact.
        - `emails.label` (string, required)
          Email label or name.
          Example: "main"
        - `emails.value` (string, required)
          Email address value.
          Example: "rebilly@example.com"
        - `emails.primary` (boolean)
          Specifies if the email address is the contact's primary email address.
          Example: true
        - `dob` (string,null)
          Contact's date of birth in ISO-8601 YYYY-MM-DD format.
          Example: "1980-04-01"
        - `jobTitle` (string,null)
          Contact's job title.
          Example: "CEO"
      - `billingAddress` (any)
        Billing address of the order.
        - `firstName` (string,null)
          Contact's first name.
          Example: "Benjamin"
        - `lastName` (string,null)
          Contact's last name.
          Example: "Franklin"
        - `organization` (string,null)
          Contact's organization.
          Example: "Rebilly"
        - `address` (string,null)
          First line of the contact's street address.
          Example: "36 Craven St"
        - `address2` (string,null)
          Second line of the contact's street address.
        - `city` (string,null)
          Contact's city of residence.
          Example: "Austin"
        - `region` (string,null)
          Contact's region of residence.
          Example: "Texas"
        - `country` (string,null)
          Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
          Example: "GB"
        - `postalCode` (string,null)
          Contact's postal code.
          Example: "WC2N 5NF"
        - `phoneNumbers` (array)
          List of phone numbers associated with the contact.
        - `phoneNumbers.label` (string, required)
          Phone number label or name.
          Example: "main"
        - `phoneNumbers.value` (string, required)
          Phone number value.
          Example: "1-512-777-0269"
        - `phoneNumbers.primary` (boolean)
          Specifies if the phone number is the contact's primary phone number.
          Example: true
        - `emails` (array)
          List of email addresses associated with the contact.
        - `emails.label` (string, required)
          Email label or name.
          Example: "main"
        - `emails.value` (string, required)
          Email address value.
          Example: "rebilly@example.com"
        - `emails.primary` (boolean)
          Specifies if the email address is the contact's primary email address.
          Example: true
        - `dob` (string,null)
          Contact's date of birth in ISO-8601 YYYY-MM-DD format.
          Example: "1980-04-01"
        - `jobTitle` (string,null)
          Contact's job title.
          Example: "CEO"
      - `abandonTime` (string,null)
        Date and time when the pending order is automatically abandoned.
If this value is not passed during order creation,
a [pending order TTL](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl) setting is used to calculate the value.
      - `couponIds` (array,null)
        List of coupons to redeem on the customer and restrict to this order.

For more information, see [Coupons](https://www.rebilly.com/docs/settings/coupons-and-discounts/).

This parameter uses the following logic:

- If this parameter is not supplied, applied coupons are not changed.
- If an empty array is supplied, all applied coupon redemptions are canceled.
- If a list of coupons is supplied, unapplied coupons in the list are applied.
  Coupons that have already been applied do not change state.
  Applied coupons that are not supplied in list are canceled.

If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued.
      - `poNumber` (string,null)
        Purchase order number displayed on the issued invoices.
        Example: "PO123456"
      - `shipping` (object) — one of (discriminator: calculator):
        Shipping settings.
        - manual:
          - `amount` (number, required)
            Shipping amount.
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "manual" (1 values)
        - rebilly:
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "rebilly" (1 values)
          - `rateId` (string,null)
            ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
            Example: "shipping-123-456"
      - `notes` (string)
        Notes for the customer displayed on the order invoice.
      - `riskMetadata` (any)
        Risk metadata.
If this value is null, this field uses risk metadata that is captured when creating the payment token.
        - `ipAddress` (string,null)
          Customer's IP address.
          Example: "93.92.91.90"
        - `fingerprint` (string,null)
          Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
          Example: "pIUt3xbgX3l9g3YDiLbx"
        - `httpHeaders` (any)
        - `browserData` (object,null)
          Browser data used for 3D Secure and risk scoring.
        - `browserData.colorDepth` (integer, required)
          Browser color depth in bits per pixel.
This value is obtained using the screen.colorDepth property.
          Example: 24
        - `browserData.isJavaEnabled` (boolean, required)
          Specifies if Java is enabled in a browser.
This value is obtained from the navigator.javaEnabled property.
        - `browserData.language` (string, required)
          Browser language settings.
This value is obtained from the navigator.language property.
          Example: "en-US"
        - `browserData.screenWidth` (integer, required)
          Width of the browser screen.
This value is obtained from the screen.width property.
          Example: 1920
        - `browserData.screenHeight` (integer, required)
          Height of the browser screen.
This value is obtained from the screen.height property.
          Example: 1080
        - `browserData.timeZoneOffset` (integer, required)
          Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the (new Date()).getTimezoneOffset() property.
          Example: 300
        - `browserData.isAdBlockEnabled` (boolean)
          Specifies if the usage of ad block has been detected in the browser.
        - `extraData` (object,null)
          Third-party data used for risk scoring.
        - `extraData.kountFraudSessionId` (string)
          Alpha-numeric fraudSessionId as provided by the Kount SDK.
          Example: "abcdefg12345abababab123456789012"
        - `extraData.payPalMerchantSessionId` (string)
          PayPal MerchantSessionID as generated by the PayPal Fraudnet SDK.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"
        - `extraData.threatMetrixSessionId` (string)
          Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
      - `customFields` (object)
        Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).

  - `_embedded.pause` (object)
    Subscription pause details.

  - `_embedded.pause.subscriptionId` (string, required)
    ID of the paused subscription.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `_embedded.pause.pausedBy` (string)
    Specifies who initiated the pause.
    Enum: "merchant", "customer"

  - `_embedded.pause.description` (string,null)
    Description of the pause reason in free form.

  - `_embedded.pause.effectiveTime` (string,null)
    Date and time when the service period pauses.

This time must be later than the current time.
If this time is earlier then the current time, the current time is used.

If this field is omitted, this value defaults to the current time.

  - `_embedded.pause.endTime` (string,null)
    Date and time when the pause ends and the subscription resumes billing.

To resume a subscription from this point in time,
use the current time or an earlier time.
If endTime is earlier then the current time, the current time is used.
If this field is empty, the subscription is indefinitely paused.

  - `_embedded.pause.timeRemaining` (string,null)
    Amount of time between the pause end time and the renewal time in ISO-8601 durations format.
By default, this value is computed as the time between the pause and the renewal.

Example: A $30 per month subscription on a 30-day month is paused on day 20 of the subscription.
There are 10 unused days on the subscription.
Therefore, the subscription renews in 10 days after it is resumed.
The upcoming invoice does not change the amount for the invoiced period, it remains at $30.
If the subscription uses a billing anchor,
the renewal time after a pause shift behaves as though the renewal time is moved forward by an [Order API operation](https://www.rebilly.com/catalog/all/orders),
and the billing anchor is ignored for that period.

For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
    Example: "P3600S"

  - `_links` (array)
    Links to related resources.

  - `_links.href` (string)
    URL of the link.

  - `_links.rel` (string)
    Relationship type of the link.
    Enum: "subscription", "pause"


## Response 2xx fields