List payment links

GET

/api/v1/payment-links

curl --request GET \
  --url https://digize.com/api/v1/payment-links \
  --header 'x-api-key: <x-api-key>'

• Digize

Payment links, the newest first, with each one’s payments and revenue over 60 days.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

name

required

string

amount

required

Any of:

integer

In the workspace currency’s minor unit: 2000 is $20.00.

integer

<= 100000000

null

null

interval

required

Any of:

string

string

Allowed values: week two_weeks month

null

null

url

required

string

active

required

boolean

payments

required

Payments over the last 60 days.

number

revenue

required

Their total, less refunds.

integer

<= 100000000

createdAt

required

string format: date-time

total

required

number

Example

{
  "rows": [
    {
      "interval": "week"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}