List all fees

GET

fees

page

integer

per_page

integer

external_customer_id

string

external_subscription_id

string

currency

enum<string>

fee_type

enum<string>

billable_metric_code

string

payment_status

enum<string>

created_at_from

string

created_at_to

string

succeeded_at_from

string

succeeded_at_to

string

failed_at_from

string

failed_at_to

string

refunded_at_from

string

refunded_at_to

string

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

per_page

integer

Number of records per page.

external_customer_id

string

Unique identifier assigned to the customer in your application.

external_subscription_id

string

External subscription ID

currency

enum<string>

Filter results by fee's currency.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

fee_type

enum<string>

The fee type. Possible values are add-on, charge, credit or subscription.

Available options:

charge,

add_on,

subscription,

credit,

instant_charge

billable_metric_code

string

Filter results by the code of the billable metric attached to the fee. Only applies to charge types.

payment_status

enum<string>

Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are pending, succeeded, failed and refunded`.

Available options:

pending,

succeeded,

failed,

refunded

created_at_from

string

Filter results created after creation date and time in UTC.

created_at_to

string

Filter results created before creation date and time in UTC.

succeeded_at_from

string

Filter results with payment success after creation date and time in UTC.

succeeded_at_to

string

Filter results with payment success after creation date and time in UTC.

failed_at_from

string

Filter results with payment failure after creation date and time in UTC.

failed_at_to

string

Filter results with payment failure after creation date and time in UTC.

refunded_at_from

string

Filter results with payment refund after creation date and time in UTC.

refunded_at_to

string

Filter results with payment refund after creation date and time in UTC.

Response

200 - application/json

fees

object[]

required

API Reference

Authorizations

Query Parameters

Response