List subscriptions

Authorizations

Authorization

string

header

required

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

Query Parameters

created_at_gte

string | null

Get events after this created time

created_at_lte

string | null

Get events created before this time

page_size

integer | null

Page size default is 10 max is 100

Required range: x > 0

page_number

integer | null

Page number default is 0

Required range: x > 0

customer_id

string | null

Filter by customer id

status

enum<string>

Filter by status

Available options:

pending,

active,

on_hold,

paused,

cancelled,

failed,

expired

Response

200 - application/json

items

object[]

required

items.created_at

string

required

Timestamp when the subscription was created

items.currency

enum<string>

required

Available options:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

items.customer

object

required

items.metadata

object

required

items.next_billing_date

string

required

Timestamp of the next scheduled billing

items.payment_frequency_count

integer

required

Number of payment frequency intervals

items.payment_frequency_interval

enum<string>

required

Available options:

Day,

Week,

Month,

Year

items.product_id

string

required

Identifier of the product associated with this subscription

items.quantity

integer

required

Number of units/items included in the subscription

items.recurring_pre_tax_amount

integer

required

Amount charged before tax for each recurring payment in smallest currency unit (e.g. cents)

items.status

enum<string>

required

Available options:

pending,

active,

on_hold,

paused,

cancelled,

failed,

expired

items.subscription_id

string

required

Unique identifier for the subscription

items.subscription_period_count

integer

required

Number of subscription period intervals

items.subscription_period_interval

enum<string>

required

Available options:

Day,

Week,

Month,

Year

items.trial_period_days

integer

required

Number of days in the trial period (0 if no trial)

API Documentation & SDKs

Payments

Subscriptions

Licenses

Customers

Webhooks

Products

Refunds

Disputes

Payouts

Miscellaneous

Authorizations

Query Parameters

Response