Update a payment link

post https://api.spherepay.co/v1/paymentLink/{id}

Updates a paymentLink object with the values passed in. Any parameters not provided are left unchanged

Path Params

string

required

A unique identifier for the paymentLink.

Body Params

name

string

An optional name for the payment link.

description

string

An optional description for the payment link.

taxRate

string

The tax rate to apply to the payment link's billing.

meta

object

Key/value pairs (JSON) for extra info on the object. Useful for external use.

successUrl

string

The redirect URL after a successful payment.

failUrl

string

The redirect URL after a failed payment.

coupon

string

The coupon ID to apply to the payment.

discordConstraints

array

The discordConstraint IDs to apply to the payment link.

discordConstraints

globalConstraint

array of strings

The paymentLinkConstraint IDs to apply to the payment link.

globalConstraint

wallets

array of objects

List of wallet IDs and their respective shares (in basis points) to receive payments from the payment link. Defaults to the application's primary wallet if unspecified.

wallets

requiresEmail

boolean

Requires email from the customer.

requiresTwitter

boolean

Requires Twitter username from the customer.

requiresTelegram

boolean

Requires Telegram username from the customer.

requiresDiscord

boolean

Requires Discord username from the customer.

requiresName

boolean

Requires full name from the customer.

requiresShippingDetails

boolean

Requires shipping details from the customer.

start

string

A non-null datetime for when the payment link becomes payable.

end

string

A non-null datetime for when the payment link becomes un-payable.

lineItems

object

required

A list of lineItemCreate objects to update the PaymentLink to

Response

200A paymentLink object.

`paymentLink` object.