List all payment links - WooshPay OpenAPI

Returns a list of your payment links.

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 *****************

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.

active

boolean

required

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

Example

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

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 {13}]

optional

string

optional

Unique identifier for the object, like 'plink_xxxx'.

object

string

optional

"payment_link"

active

boolean

optional

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

after_completion

object

optional

Behavior after the purchase is complete.

billing_address_collection

enum<string>

optional

Configuration for collecting the customer’s billing address.

Allowed values:

autorequired

currency

string

optional

Three-letter ISO currency code. Must be a supported currency.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

phone_number_collection

object

optional

Controls phone number collection settings during checkout.

shipping_address_collection

object

optional

Configuration for collecting the customer’s shipping address.

url

string

optional

The public URL that can be shared with customers.

line_items

object

optional

The line items representing what is being sold. This field is not included by default. This field is not included by default. To include it in the response, expand the line_items field.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

Example

{
  "object": "\"list\"",
  "url": "string",
  "has_more": true,
  "data": [
    {
      "id": "string",
      "object": "string",
      "active": true,
      "after_completion": {
        "type": "redirect",
        "hosted_confirmation": {
          "custom_message": "string"
        },
        "redirect": {
          "url": "string"
        }
      },
      "billing_address_collection": "auto",
      "currency": "string",
      "livemode": true,
      "metadata": {},
      "phone_number_collection": {
        "enabled": true
      },
      "shipping_address_collection": {
        "allowed_countries": [
          "string"
        ]
      },
      "url": "string",
      "line_items": {
        "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"
          }
        ]
      },
      "created": 0
    }
  ]
}