List all payment links

Changed on

Returns a list of your payment links.

get/v1/payment_links

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_links
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

activeboolean

Only return payment links that are active or inactive (e.g., pass false to list all inactive payment links).

ending_beforestring

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.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

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

starting_afterstring

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.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ////////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ////////////////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

Some revisions have not been checked yet.