List Payment Links – PriceBlocs

v1.0.0

⌘K

List all Payment Links

Returns a list of your Payment Links. The payment links are returned sorted by creation date, with the most recently created Payment Links appearing first.

Parameters

livemode
booleanoptional
- Has the valuetrueif the object exists inlivemode or the valuefalseif the object exists intestmode.

Returns

A dictionary with a data property that contains an array of up to 20 Payment Links. Each entry in the array is a separate Payment Link object. The response includes additional attributes which describe the remaining Payment Links available to retrieve, as well as alinkshash which describes the locations for the retrieval of additional resources.

Have any questions or feedback?

or join us on Discord

GET

/v1/payment-links

1
curl https://api.priceblocs.com/v1/payment-links \
2
 -H "Authorization: Bearer {{API_KEY_SECRET_TEST}}"

Get API keys

Response

1
{
2
  "object": "list",
3
  "url": "/v1/payment-links",
4
  "has_more": true,
5
  "data": {
6
    "url": "https://priceblocs.com/test/links/short_id",
7
    "brand_url": "https://priceblocs.com/test/links/short_id",
8
    "livemode": false,
9
    "id": "00000000-0000-0000-0000-000000000000",
10
    "object": "payment_link",
11
    "short_id": "short_id",
12
    "title": "My first payment link",
13
    "description": "Each link will start a new checkout session when clicked",
14
    "success_url": "https://priceblocs.com/checkout/success",
15
    "cancel_url": "https://priceblocs.com/checkout/error",
16
    "created": 1628234366,
17
    "updated": 1628234366,
18
    "payment_method_types": [
19
      "card"
20
    ],
21
    "currency": "usd",
22
    "customer_email": "someone@gmail.com",
23
    "customer": null,
24
    "status": "active",
25
    "discounts": [
26
      {
27
        "coupon": "coupon123"
28
      }
29
    ],
30
    "billing_address_collection": "auto",
31
    "shipping_address_collection": {
32
      "allowed_countries": [
33
        "US"
34
      ]
35
    },
36
    "mode": "subscription",
37
    "submit_type": "pay",
38
    "allow_promotion_codes": false,
39
    "adjustable_quantity": {
40
      "enabled": true,
41
      "maximum": 99,
42
      "minimum": 1
43
    },
44
    "shipping_worldwide": false,
45
    "tax_rates": [
46
      "txr_123"
47
    ],
48
    "dynamic_tax_rates": [
49
      "txr_456"
50
    ],
51
    "automatic_tax": {
52
      "enabled": true
53
    },
54
    "tax_id_collection": {
55
      "enabled": false,
56
      "type": "standard"
57
    },
58
    "consent_collection": {
59
      "promotions": "auto"
60
    },
61
    "after_expiration": {
62
      "recovery": {
63
        "enabled": true,
64
        "allow_promotion_codes": true
65
      }
66
    },
67
    "expires_at": 1628234366,
68
    "shipping_options": [
69
      {
70
        "shipping_rate": "shr_456"
71
      }
72
    ],
73
    "payment_intent_data": {
74
      "capture_method": "automatic",
75
      "transfer_data": {
76
        "destination": "act_123"
77
      }
78
    },
79
    "trial_period_days": null,
80
    "trial_end": null,
81
    "line_items": [
82
      {
83
        "price": "p_A_1",
84
        "product": "p_A",
85
        "currency": "usd",
86
        "interval": "month",
87
        "quantity": 1,
88
        "dynamic_tax_rates": null,
89
        "tax_rates": null
90
      }
91
    ]
92
  },
93
  "page": 1,
94
  "page_size": 20,
95
  "total": 198,
96
  "links": {
97
    "self": {
98
      "page": "1",
99
      "rel": "self",
100
      "url": "https://api.priceblocs.com/v1/payment-links?page=1"
101
    },
102
    "first": {
103
      "page": "1",
104
      "rel": "first",
105
      "url": "https://api.priceblocs.com/v1/payment-links?page=1"
106
    },
107
    "last": {
108
      "page": "10",
109
      "rel": "last",
110
      "url": "https://api.priceblocs.com/v1/payment-links?page=10"
111
    },
112
    "next": {
113
      "page": "2",
114
      "rel": "next",
115
      "url": "https://api.priceblocs.com/v1/payment-links?page=2"
116
    }
117
  }
118
}

Show docs menu