Delete a payment link

Delete a payment link.
Parameters
Has no parameters
Returns
  • Returns a deleted object on success. Otherwise, this call returnsan error
Have any questions?
DELETE
/v1/payment-links/:id
1
curl https://api.priceblocs.com/v1/payment-links/{{PAYMENT_LINK_ID}} \
2
-H "Authorization: Bearer {{API_KEY_SECRET_TEST}}" \
3
-X DELETE
Response
1
{
2
"url": "https://priceblocs.com/test/links/short_id",
3
"brand_url": "https://priceblocs.com/test/links/short_id",
4
"livemode": false,
5
"id": "00000000-0000-0000-0000-000000000000",
6
"object": "payment_link",
7
"short_id": "short_id",
8
"title": "My first payment link",
9
"description": "Each link will start a new checkout session when clicked",
10
"success_url": "https://priceblocs.com/checkout/success",
11
"cancel_url": "https://priceblocs.com/checkout/error",
12
"created": 1628234366,
13
"updated": 1628234366,
14
"payment_method_types": [
15
"card"
16
],
17
"currency": "usd",
18
"customer_email": "someone@gmail.com",
19
"customer": null,
20
"status": "active",
21
"discounts": [
22
{
23
"coupon": "coupon123"
24
}
25
],
26
"billing_address_collection": "auto",
27
"shipping_address_collection": {
28
"allowed_countries": [
29
"US"
30
]
31
},
32
"mode": "subscription",
33
"submit_type": "pay",
34
"allow_promotion_codes": false,
35
"adjustable_quantity": {
36
"enabled": true,
37
"maximum": 99,
38
"minimum": 1
39
},
40
"shipping_worldwide": false,
41
"tax_rates": [
42
"txr_123"
43
],
44
"dynamic_tax_rates": [
45
"txr_456"
46
],
47
"automatic_tax": {
48
"enabled": true
49
},
50
"tax_id_collection": {
51
"enabled": false,
52
"type": "standard"
53
},
54
"consent_collection": {
55
"promotions": "auto"
56
},
57
"after_expiration": {
58
"recovery": {
59
"enabled": true,
60
"allow_promotion_codes": true
61
}
62
},
63
"expires_at": 1628234366,
64
"shipping_rates": [
65
"shr_123"
66
],
67
"payment_intent_data": {
68
"capture_method": "automatic",
69
"transfer_data": {
70
"destination": "act_123"
71
}
72
},
73
"trial_period_days": null,
74
"trial_end": null,
75
"line_items": [
76
{
77
"price": "p_A_1",
78
"product": "p_A",
79
"currency": "usd",
80
"interval": "month",
81
"quantity": 1,
82
"dynamic_tax_rates": null,
83
"tax_rates": null
84
}
85
]
86
}
Show docs menu

Delete a payment link

Delete a payment link.
Parameters
Has no parameters
Returns
  • Returns a deleted object on success. Otherwise, this call returnsan error
Have any questions?
DELETE
/v1/payment-links/:id
1
curl https://api.priceblocs.com/v1/payment-links/{{PAYMENT_LINK_ID}} \
2
-H "Authorization: Bearer {{API_KEY_SECRET_TEST}}" \
3
-X DELETE
Response
1
{
2
"url": "https://priceblocs.com/test/links/short_id",
3
"brand_url": "https://priceblocs.com/test/links/short_id",
4
"livemode": false,
5
"id": "00000000-0000-0000-0000-000000000000",
6
"object": "payment_link",
7
"short_id": "short_id",
8
"title": "My first payment link",
9
"description": "Each link will start a new checkout session when clicked",
10
"success_url": "https://priceblocs.com/checkout/success",
11
"cancel_url": "https://priceblocs.com/checkout/error",
12
"created": 1628234366,
13
"updated": 1628234366,
14
"payment_method_types": [
15
"card"
16
],
17
"currency": "usd",
18
"customer_email": "someone@gmail.com",
19
"customer": null,
20
"status": "active",
21
"discounts": [
22
{
23
"coupon": "coupon123"
24
}
25
],
26
"billing_address_collection": "auto",
27
"shipping_address_collection": {
28
"allowed_countries": [
29
"US"
30
]
31
},
32
"mode": "subscription",
33
"submit_type": "pay",
34
"allow_promotion_codes": false,
35
"adjustable_quantity": {
36
"enabled": true,
37
"maximum": 99,
38
"minimum": 1
39
},
40
"shipping_worldwide": false,
41
"tax_rates": [
42
"txr_123"
43
],
44
"dynamic_tax_rates": [
45
"txr_456"
46
],
47
"automatic_tax": {
48
"enabled": true
49
},
50
"tax_id_collection": {
51
"enabled": false,
52
"type": "standard"
53
},
54
"consent_collection": {
55
"promotions": "auto"
56
},
57
"after_expiration": {
58
"recovery": {
59
"enabled": true,
60
"allow_promotion_codes": true
61
}
62
},
63
"expires_at": 1628234366,
64
"shipping_rates": [
65
"shr_123"
66
],
67
"payment_intent_data": {
68
"capture_method": "automatic",
69
"transfer_data": {
70
"destination": "act_123"
71
}
72
},
73
"trial_period_days": null,
74
"trial_end": null,
75
"line_items": [
76
{
77
"price": "p_A_1",
78
"product": "p_A",
79
"currency": "usd",
80
"interval": "month",
81
"quantity": 1,
82
"dynamic_tax_rates": null,
83
"tax_rates": null
84
}
85
]
86
}