Retrieve a payment link's line items

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

string

optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Example

{
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {8}]

optional

string

optional

Unique identifier for the object, like "li_xxx"

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

amount_subtotal

string

optional

Total before any discounts or taxes are applied.

amount_total

string

optional

Total after discounts and taxes.

currency

string

optional

Three-letter ISO currency code.

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.

price

object

optional

The price used to generate the line item.

quantity

string

optional

The quantity of products being purchased.

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "amount_subtotal": "string",
            "amount_total": "string",
            "currency": "string",
            "description": "string",
            "price": {
                "id": "string",
                "object": "string",
                "active": true,
                "billing_scheme": "per_unit",
                "created": 0,
                "currency": "string",
                "livemode": true,
                "lookup_key": "string",
                "metadata": {},
                "nickname": "string",
                "product": "string",
                "type": "one_time",
                "unit_amount": 0,
                "recurring": {
                    "interval": "day",
                    "interval_count": 0,
                    "usage_type": "licensed"
                },
                "tiers": [
                    {
                        "up_to": "string",
                        "flat_amount": "string",
                        "unit_amount": "string"
                    }
                ]
            },
            "quantity": "string"
        }
    ]
}