Solverr

Payment links

Turn off a payment link

Turns the link off. Customers who open it see that it no longer exists; invoices already created from it stay payable. Rate limit: 60 per minute per API key, shared with the other endpoints that have this limit.

DELETE
/api/v1/payment-links/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

A live API key, sk_live_ followed by 32 base58 characters.

Path Parameters

id*string

Payment link id (starts with lnk_).

Response Body

The payment link, now with active false.

application/json
  1. response
id*string
object*string
mode*Mode

Always live on the objects your API key creates and reads. Only demo store invoices, seen through the public checkout endpoints, are test.

Value in"live""test"
url*string

The shareable link.

Formaturi
title*string
amount*|

Fixed amount, or null for a tip link.

currency*Currency
Value in"USD""EUR""INR"
redirect_url*|

Where the checkout sends the customer after paying. When null, the customer goes to your business website, if you set one.

Formaturi
active*boolean
created_at*string
Formatdate-time
Example Request
curl -X DELETE 'https://example.com/api/v1/payment-links/string'
Example Response
{  "id": "lnk_8Fq2xT4mW9pL3vN7rB2s",  "object": "payment_link",  "mode": "live",  "url": "http://example.com",  "title": "string",  "amount": "string",  "currency": "USD",  "redirect_url": "http://example.com",  "active": true,  "created_at": "2019-08-24T14:15:22Z"}