Get metered usage for the current period

GET

/v1/billing/usage

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.feitpay.com/v1/billing/usage"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Gryphem-Environment", "test")
  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/billing/usage';
const options = {
  method: 'GET',
  headers: {'Gryphem-Environment': 'test', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.feitpay.com/v1/billing/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Gryphem-Environment: test'

Authorizations

ApiKey
Session

Parameters

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Gryphem-Environment

string

default: test

Allowed values: test live

test (default) or live for dashboard sessions. API keys determine the environment.

Responses

200

Current fee schedule and metered usage by month.

application/json

object

object

required

string

Allowed value: usage

livemode

required

boolean

fee_schedule

required

One of:

object
null

object

required

string

name

required

string

version

required

integer

currency

required

string

percentage_bps

required

integer

fixed_fee

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

monthly_fee

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

minimum_monthly_fee

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

included_volume

required

string | null

availability

required

string

Allowed values: available indicative contact_sales

features

required

Array<string>

public

required

boolean

effective_from

required

string format: date-time

retired_at

required

string | null format: date-time

periods

required

Array<object>

object

period

required

string format: date

gmv_currency

required

string

fee_currency

required

string

payments_count

required

integer

gmv

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

fees

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

notes

required

Array<string>

Example

{
  "object": "usage",
  "fee_schedule": {
    "fixed_fee": "59.90",
    "monthly_fee": "59.90",
    "minimum_monthly_fee": "59.90",
    "availability": "available"
  },
  "periods": [
    {
      "gmv": "59.90",
      "fees": "59.90"
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer