Update a link

Path

• id string Required
  The link's ID, such as lnk_nt842tPNne3lf0ka.

Body

• amount integer
  The price in minor units of currency: 4900 with USD is $49.00. From the equivalent of $1.00 up to 1,000,000.00 in the currency.
• currency string
  USD, EUR, GBP, CAD, AUD. Defaults to USD.
• name string
  What the customer is paying for, up to 80 characters. It becomes the description of each payment made through the link, shown on the receipt.
• description string
  More about it, shown in the checkout's details, up to 300 characters.
• success_url string
  Where checkout sends the customer after paying, with payment_id added to its query. Use https://; http:// works only for localhost and 127.0.0.1. Defaults to the redirect in your checkout settings, then the receipt.
• status string
  active or archived. You receive link.archived or link.restored.

Errors

• 400 invalid_request
  A field is missing, unknown or out of range. field names it.
• 404 not_found
  No link with that ID belongs to your business.
• 403 test_mode_unavailable
  A test key can't change, archive or restore links on a live business, so use a live key.
• 409 link_disabled
  402pay disabled the link, so status can't go back to active.

Any request can also fail on its key or its body. See errors.