Payment numbers

GET

/api/v1/payment-stats

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

• Digize

What was collected over 30 days, less refunds, what open invoices are owed and overdue, and monthly recurring revenue.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

collected

required

object

value

required

number

change

required

number

trend

required

Array<number>

outstanding

required

object

amount

required

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

integer

<= 100000000

count

required

number

overdue

required

object

amount

required

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

integer

<= 100000000

count

required

number

mrr

required

object

amount

required

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

integer

<= 100000000

subscriptions

required

number

Example ^generated

{
  "collected": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "outstanding": {
    "amount": 1,
    "count": 1
  },
  "overdue": {
    "amount": 1,
    "count": 1
  },
  "mrr": {
    "amount": 1,
    "subscriptions": 1
  }
}

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"
  }
}