# Deactivate a Subscription Link

Deactivate an existing .

Endpoint: PUT /subscription_links/{subscription_link_id}
Version: 2022-02-01
Security: BasicAuth

## Path parameters:

  - `subscription_link_id` (string, required)
    The  ID.

## Request fields (application/json):

  - `state` (string)
    The current state of the .
    Enum: "DEACTIVATED"

  - `tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

## Response 200 fields (application/json):

  - `id` (string)
    The ID of the resource.

  - `created_at` (string)
    Timestamp of when the object was created.

  - `updated_at` (string)
    Timestamp of when the object was last updated.

  - `application` (string)
    ID of the  associated with the resource.

  - `currency` (string)
    ISO 4217 3-letter currency code.
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"

  - `merchant_id` (string)
    The  asssociated with the .

  - `nickname` (string)
    A human-readable name for the resource.

  - `type` (string)
    The type of . This is very useful for filtering and informing the front-end about the type of .
    Enum: "SUBSCRIPTION_PLAN", "MULTIPLE_SUBSCRIPTION_PLANS", "CUSTOM"

  - `plans` (array)
    A list of  objects, along with additional information for each plan if selected.

  - `plans.subscription_plan_id` (string)
    The  that a customer selects via the .

  - `plans.name` (string)
    The name of the  you wish to display to your buyer. This may differ from the internal  of the .

  - `plans.image_details` (object)
    image locations.

  - `plans.image_details.primary_image_url` (string)
    The primary image location.

  - `plans.image_details.alternative_image_urls` (array)
    The locations of backup images if there is an issue with the primary image.

  - `plans.url_details` (object)

  - `plans.url_details.success_return_url` (string)
    The URL to redirect the user after they subscribe to a subscription.

  - `plans.url_details.unsuccessful_return_url` (string)
    If the attempt to subscribe fails, redirect the user to this URL.

  - `plans.url_details.expired_session_url` (string)
    The URL to redirect the user to if their session times out.

  - `plans.url_details.terms_of_service_url` (string)
    A Terms of Service URL.

  - `plans.branding` (object)
    Object containing branding details for the .

  - `plans.branding.brand_color` (string)
    Hex code of branding color.
    Example: "#F2F2F2"

  - `plans.branding.accent_color` (string)
    Hex code of the accent color.
    Example: "#F2F2F2"

  - `plans.branding.logo` (string)
    URL of the logo for the payment link.

  - `plans.branding.icon` (string)
    URL for the icon of the payment link.

  - `plans.branding.logo_alternative_text` (string,null)
    Alternate text displayed if the logo image cannot display.

  - `plans.branding.button_font_color` (string,null)
    Hex code of the button font color.

  - `plans.branding.button_label` (string,null)
    The text that displays within the button.

  - `plans.allowed_payment_methods` (array)
    Payment methods allowed on the .
    Enum: "BANK_ACCOUNT", "PAYMENT_CARD"

  - `plans.additional_details` (object)
    Object containing additional details about the .

  - `plans.additional_details.collect_name` (boolean)
    The collected user's name.

  - `plans.additional_details.collect_email` (boolean)
    The collected email address.

  - `plans.additional_details.collect_phone_number` (boolean)
    The collected phone number.

  - `plans.additional_details.collect_billing_address` (boolean)
    The collected billing address.

  - `plans.additional_details.collect_shipping_address` (boolean)
    The collected shipping address.

  - `plans.additional_details.expiration_in_minutes` (string)
    How long (in minutes) the link should be valid for. Defaults to 60 minutes.

  - `plans.additional_details.expired_session_url` (string)
    The URL to redirect the user to if the  expires.

  - `plans.additional_details.receipt_requested_delivery_methods` (array)
    A list of requested delivery methods. Each method specifies 
the type of delivery and the destination(s) where the receipt should be sent.

  - `plans.additional_details.receipt_requested_delivery_methods.type` (string, required)
    The method of receipt delivery.
    Enum: "EMAIL", "SMS", "PRINT"

  - `plans.additional_details.receipt_requested_delivery_methods.destinations` (array, required)
    A list of destination addresses or identifiers where the receipt should be sent.

  - `plans.additional_details.send_receipt` (boolean)
    Whether to send the user a .

  - `state` (string)
    The current state of the .
    Enum: "ACTIVE", "DEACTIVATED", "EXPIRED", "COMPLETED"

  - `tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `link_url` (string)
    The URL of the .

  - `link_expires_at` (string)
    Timestamp of when the  will expire.

  - `_links` (object)

  - `_links.self` (object)
    Link to the resource that was used in the request.

  - `_links.self.href` (string)

## Response 400 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The  error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The  error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The  error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 404 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The  error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The  error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.