Get billing

GET

/api/v1/billing

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

• Digize

This month’s usage per meter with what it costs so far, the card on file, the details printed on invoices, past invoices, spending alerts and whether the workspace is behind on paying.

Needs the settings:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

ready

required

boolean

periodStart

required

string format: date-time

periodEnd

required

string format: date-time

meters

required

Array<object>

object

id

required

string

Allowed values: sms email storage build_minutes requests

used

required

number

free

required

number

rate

required

number

per

required

number

daily

required

Array<number>

paymentMethod

required

Any of:

object

object

brand

required

string

last4

required

string

expMonth

required

number

expYear

required

number

name

required

string

null

null

billingEmail

required

string

company

required

string

taxId

required

string

address

required

string

invoices

required

Array<object>

object

id

required

string

number

required

string

periodStart

required

string format: date-time

periodEnd

required

string format: date-time

amount

required

number

status

required

string

Allowed values: paid open failed void

paidAt

required

Any of:

string

string format: date-time

null

null

alerts

required

Array<number>

standing

required

object

state

required

string

Allowed values: good past_due read_only

since

required

Any of:

string

string format: date-time

null

null

failedAttempts

required

number

readOnlyAfter

required

number

invoiceId

required

string | null

amountDue

required

number

Example

{
  "meters": [
    {
      "id": "sms"
    }
  ],
  "invoices": [
    {
      "status": "paid"
    }
  ],
  "standing": {
    "state": "good"
  }
}

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