Get Billing Details

GET

api

customers

{externalId}

billing

curl --request GET \
  --url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
  --header 'Authorization: <api-key>'

{
  "customer": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "organizationId": "<string>",
    "email": "<string>",
    "name": "<string>",
    "invoiceNumberBase": "<string>",
    "archived": true,
    "logoURL": "<string>",
    "iconURL": "<string>",
    "domain": "<string>",
    "billingAddress": {
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "phone": "<string>"
    },
    "externalId": "<string>",
    "userId": "<string>",
    "catalogId": "<string>"
  },
  "subscriptions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "trialing",
      "defaultPaymentMethodId": "<string>",
      "backupPaymentMethodId": "<string>",
      "trialEnd": "2023-11-07T05:31:56Z",
      "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
      "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
      "metadata": {},
      "canceledAt": "2023-11-07T05:31:56Z",
      "cancelScheduledAt": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "runBillingAtPeriodStart": true,
      "interval": "day",
      "intervalCount": 123,
      "billingCycleAnchorDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "current": true,
      "subscriptionItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "subscriptionId": "<string>",
          "name": "<string>",
          "addedDate": "2023-11-07T05:31:56Z",
          "priceId": "<string>",
          "unitPrice": 123,
          "quantity": 123,
          "metadata": {},
          "price": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        }
      ]
    }
  ],
  "invoices": [
    {
      "invoice": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "livemode": true,
        "purchaseId": "<string>",
        "invoiceNumber": "<string>",
        "invoiceDate": "2023-11-07T05:31:56Z",
        "billingPeriodId": "null",
        "dueDate": "2023-11-07T05:31:56Z",
        "customerId": "<string>",
        "organizationId": "<string>",
        "status": "draft",
        "billingInterval": "day",
        "subscriptionId": "null",
        "billingPeriodStartDate": "2023-11-07T05:31:56Z",
        "billingPeriodEndDate": "2023-11-07T05:31:56Z",
        "billingIntervalCount": 123,
        "billingAnchorDate": "2023-11-07T05:31:56Z",
        "ownerMembershipId": "<string>",
        "pdfURL": "<string>",
        "receiptPdfURL": "<string>",
        "memo": "<string>",
        "bankPaymentOnly": true,
        "type": "purchase",
        "currency": "USD",
        "taxAmount": 123,
        "subtotal": 123,
        "taxType": "amusement_tax",
        "taxCountry": "AF",
        "taxState": "<string>",
        "taxRatePercentage": "<string>",
        "applicationFee": 123
      },
      "invoiceLineItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "invoiceId": "<string>",
          "quantity": 123,
          "priceId": "<string>",
          "description": "<string>",
          "price": 123
        }
      ]
    }
  ],
  "paymentMethods": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "billingDetails": {
        "name": "<string>",
        "email": "<string>",
        "address": {
          "name": "<string>",
          "address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          }
        }
      },
      "type": "card",
      "default": true,
      "paymentMethodData": {},
      "metadata": {}
    }
  ],
  "purchases": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "name": "<string>",
      "status": "open",
      "customerId": "<string>",
      "organizationId": "<string>",
      "billingCycleAnchor": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "quantity": 123,
      "priceType": "subscription",
      "trialPeriodDays": 123,
      "pricePerBillingCycle": 123,
      "intervalUnit": "day",
      "intervalCount": 123,
      "firstInvoiceValue": 123,
      "totalPurchaseValue": "<any>",
      "bankPaymentOnly": true,
      "purchaseDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "proposal": "<string>",
      "archived": true,
      "billingAddress": "<string>",
      "metadata": {}
    }
  ],
  "currentSubscriptions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "trialing",
      "defaultPaymentMethodId": "<string>",
      "backupPaymentMethodId": "<string>",
      "trialEnd": "2023-11-07T05:31:56Z",
      "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
      "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
      "metadata": {},
      "canceledAt": "2023-11-07T05:31:56Z",
      "cancelScheduledAt": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "runBillingAtPeriodStart": true,
      "interval": "day",
      "intervalCount": 123,
      "billingCycleAnchorDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "current": true,
      "subscriptionItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "subscriptionId": "<string>",
          "name": "<string>",
          "addedDate": "2023-11-07T05:31:56Z",
          "priceId": "<string>",
          "unitPrice": 123,
          "quantity": 123,
          "metadata": {},
          "price": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        }
      ]
    }
  ],
  "catalog": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "organizationId": "<string>",
    "isDefault": true,
    "name": "<string>",
    "products": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "livemode": true,
        "name": "<string>",
        "description": "<string>",
        "imageURL": "<string>",
        "organizationId": "<string>",
        "displayFeatures": [
          {
            "enabled": true,
            "label": "<string>",
            "details": "<string>"
          }
        ],
        "active": true,
        "singularQuantityLabel": "<string>",
        "pluralQuantityLabel": "<string>",
        "catalogId": "<string>",
        "prices": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        ],
        "defaultPrice": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "intervalUnit": "day",
          "name": "<string>",
          "intervalCount": 123,
          "type": "subscription",
          "trialPeriodDays": 123,
          "setupFeeAmount": 123,
          "isDefault": true,
          "unitPrice": 123,
          "productId": "<string>",
          "active": true,
          "currency": "USD"
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

externalId

string

required

The ID of the customer, as defined in your application

Response

200

application/json

Successful response

customer

object

required

subscriptions

object[]

required

subscriptions.id

string

required

subscriptions.createdAt

string

required

subscriptions.updatedAt

string | null

required

subscriptions.livemode

boolean

required

subscriptions.customerId

string

required

subscriptions.organizationId

string

required

subscriptions.status

enum<string>

required

Available options:

trialing,

active,

past_due,

unpaid,

cancellation_scheduled,

incomplete,

incomplete_expired,

canceled,

paused

subscriptions.defaultPaymentMethodId

string | null

required

subscriptions.backupPaymentMethodId

string | null

required

subscriptions.trialEnd

string | null

required

subscriptions.currentBillingPeriodStart

string

required

subscriptions.currentBillingPeriodEnd

string

required

subscriptions.metadata

object | null

required

subscriptions.canceledAt

string | null

required

subscriptions.cancelScheduledAt

string | null

required

subscriptions.priceId

string

required

subscriptions.runBillingAtPeriodStart

boolean | null

required

subscriptions.interval

enum<string>

required

Available options:

day,

week,

month,

year

subscriptions.intervalCount

number

required

safeZodPositiveInteger

subscriptions.billingCycleAnchorDate

string

required

subscriptions.name

string | null

required

subscriptions.current

boolean

required

Whether the subscription is current (statuses "active", "trialing", "past_due", or "cancellation_scheduled")

subscriptions.subscriptionItems

object[]

required

subscriptions.subscriptionItems.id

string

required

subscriptions.subscriptionItems.createdAt

string

required

subscriptions.subscriptionItems.updatedAt

string | null

required

subscriptions.subscriptionItems.livemode

boolean

required

subscriptions.subscriptionItems.subscriptionId

string

required

subscriptions.subscriptionItems.name

string | null

required

subscriptions.subscriptionItems.addedDate

string

required

subscriptions.subscriptionItems.priceId

string

required

subscriptions.subscriptionItems.unitPrice

required

safeZodPositiveInteger

subscriptions.subscriptionItems.quantity

number

required

safeZodPositiveInteger

subscriptions.subscriptionItems.metadata

object | null

required

subscriptions.subscriptionItems.price

object

required

A subscription price, which will have details on the interval, default trial period, and setup fee (if any).

invoices

object[]

required

invoices.invoice

object

required

An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.

invoices.invoice.id

string

required

invoices.invoice.createdAt

string

required

invoices.invoice.updatedAt

string | null

required

invoices.invoice.livemode

boolean

required

invoices.invoice.purchaseId

string

required

invoices.invoice.invoiceNumber

string

required

invoices.invoice.invoiceDate

string

required

invoices.invoice.billingPeriodId

enum<string> | null

required

Available options:

null

invoices.invoice.dueDate

string | null

required

invoices.invoice.customerId

string

required

invoices.invoice.organizationId

string

required

invoices.invoice.status

enum<string>

required

Available options:

draft,

open,

paid,

uncollectible,

void,

refunded,

partially_refunded,

awaiting_payment_confirmation

invoices.invoice.billingInterval

enum<string> | null

required

Available options:

day,

week,

month,

year

invoices.invoice.subscriptionId

enum<string> | null

required

Available options:

null

invoices.invoice.billingPeriodStartDate

string | null

required

invoices.invoice.billingPeriodEndDate

string | null

required

invoices.invoice.billingIntervalCount

number | null

required

invoices.invoice.billingAnchorDate

string | null

required

invoices.invoice.ownerMembershipId

string | null

required

invoices.invoice.pdfURL

string | null

required

invoices.invoice.receiptPdfURL

string | null

required

invoices.invoice.memo

string | null

required

invoices.invoice.bankPaymentOnly

boolean | null

required

invoices.invoice.type

enum<string>

required

Available options:

purchase

invoices.invoice.currency

enum<string>

required

Available options:

USD,

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,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

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,

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,

SLE,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

invoices.invoice.taxAmount

number | null

required

invoices.invoice.subtotal

number | null

required

invoices.invoice.taxType

enum<string> | null

required

Available options:

amusement_tax,

communications_tax,

gst,

hst,

igst,

jct,

lease_tax,

pst,

qst,

rst,

sales_tax,

vat,

none

invoices.invoice.taxCountry

enum<string> | null

required

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IL,

IT,

JM,

JP,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

ME,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

SH,

KN,

LC,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

invoices.invoice.taxState

string | null

required

invoices.invoice.taxRatePercentage

string | null

required

invoices.invoice.applicationFee

number | null

required

invoices.invoiceLineItems

object[]

required

paymentMethods

object[]

required

purchases

object[]

required

A purchase record, which describes a transaction that can be associated with either a subscription or single payment price. Each purchase has a specific type that determines its behavior and required fields.

catalog

object

required

catalog.id

string

required

catalog.createdAt

required

safeZodDate

catalog.updatedAt

required

safeZodDate

catalog.livemode

boolean

required

catalog.organizationId

string

required

catalog.isDefault

boolean

required

catalog.name

string

required

catalog.products

object[]

required

catalog.products.id

string

required

catalog.products.createdAt

required

safeZodDate

catalog.products.updatedAt

required

safeZodDate

catalog.products.livemode

boolean

required

catalog.products.name

string

required

catalog.products.description

string | null

required

catalog.products.imageURL

string | null

required

catalog.products.organizationId

string

required

catalog.products.displayFeatures

object[] | null

required

catalog.products.active

boolean

required

catalog.products.singularQuantityLabel

string | null

required

catalog.products.pluralQuantityLabel

string | null

required

catalog.products.catalogId

string

required

catalog.products.prices

object[]

required

A subscription price, which will have details on the interval, default trial period, and setup fee (if any).

catalog.products.defaultPrice

object

required

The default price for the product. If no price is explicitly set as default, will return the first price created for the product..

currentSubscriptions

object[]

The current subscriptions for the customer. By default, customers can only have one active subscription at a time. This will only return multiple subscriptions if you have enabled multiple subscriptions per customer.

currentSubscriptions.id

string

required

currentSubscriptions.createdAt

string

required

currentSubscriptions.updatedAt

string | null

required

currentSubscriptions.livemode

boolean

required

currentSubscriptions.customerId

string

required

currentSubscriptions.organizationId

string

required

currentSubscriptions.status

enum<string>

required

Available options:

trialing,

active,

past_due,

unpaid,

cancellation_scheduled,

incomplete,

incomplete_expired,

canceled,

paused

currentSubscriptions.defaultPaymentMethodId

string | null

required

currentSubscriptions.backupPaymentMethodId

string | null

required

currentSubscriptions.trialEnd

string | null

required

currentSubscriptions.currentBillingPeriodStart

string

required

currentSubscriptions.currentBillingPeriodEnd

string

required

currentSubscriptions.metadata

object | null

required

currentSubscriptions.canceledAt

string | null

required

currentSubscriptions.cancelScheduledAt

string | null

required

currentSubscriptions.priceId

string

required

currentSubscriptions.runBillingAtPeriodStart

boolean | null

required

currentSubscriptions.interval

enum<string>

required

Available options:

day,

week,

month,

year

currentSubscriptions.intervalCount

number

required

safeZodPositiveInteger

currentSubscriptions.billingCycleAnchorDate

string

required

currentSubscriptions.name

string | null

required

currentSubscriptions.current

boolean

required

Whether the subscription is current (statuses "active", "trialing", "past_due", or "cancellation_scheduled")

currentSubscriptions.subscriptionItems

object[]

required

currentSubscriptions.subscriptionItems.id

string

required

currentSubscriptions.subscriptionItems.createdAt

string

required

currentSubscriptions.subscriptionItems.updatedAt

string | null

required

currentSubscriptions.subscriptionItems.livemode

boolean

required

currentSubscriptions.subscriptionItems.subscriptionId

string

required

currentSubscriptions.subscriptionItems.name

string | null

required

currentSubscriptions.subscriptionItems.addedDate

string

required

currentSubscriptions.subscriptionItems.priceId

string

required

currentSubscriptions.subscriptionItems.unitPrice

required

safeZodPositiveInteger

currentSubscriptions.subscriptionItems.quantity

number

required

safeZodPositiveInteger

currentSubscriptions.subscriptionItems.metadata

object | null

required

currentSubscriptions.subscriptionItems.price

object

required

A subscription price, which will have details on the interval, default trial period, and setup fee (if any).

Update Customer Get Discount

curl --request GET \
  --url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
  --header 'Authorization: <api-key>'

{
  "customer": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "organizationId": "<string>",
    "email": "<string>",
    "name": "<string>",
    "invoiceNumberBase": "<string>",
    "archived": true,
    "logoURL": "<string>",
    "iconURL": "<string>",
    "domain": "<string>",
    "billingAddress": {
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "phone": "<string>"
    },
    "externalId": "<string>",
    "userId": "<string>",
    "catalogId": "<string>"
  },
  "subscriptions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "trialing",
      "defaultPaymentMethodId": "<string>",
      "backupPaymentMethodId": "<string>",
      "trialEnd": "2023-11-07T05:31:56Z",
      "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
      "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
      "metadata": {},
      "canceledAt": "2023-11-07T05:31:56Z",
      "cancelScheduledAt": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "runBillingAtPeriodStart": true,
      "interval": "day",
      "intervalCount": 123,
      "billingCycleAnchorDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "current": true,
      "subscriptionItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "subscriptionId": "<string>",
          "name": "<string>",
          "addedDate": "2023-11-07T05:31:56Z",
          "priceId": "<string>",
          "unitPrice": 123,
          "quantity": 123,
          "metadata": {},
          "price": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        }
      ]
    }
  ],
  "invoices": [
    {
      "invoice": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "livemode": true,
        "purchaseId": "<string>",
        "invoiceNumber": "<string>",
        "invoiceDate": "2023-11-07T05:31:56Z",
        "billingPeriodId": "null",
        "dueDate": "2023-11-07T05:31:56Z",
        "customerId": "<string>",
        "organizationId": "<string>",
        "status": "draft",
        "billingInterval": "day",
        "subscriptionId": "null",
        "billingPeriodStartDate": "2023-11-07T05:31:56Z",
        "billingPeriodEndDate": "2023-11-07T05:31:56Z",
        "billingIntervalCount": 123,
        "billingAnchorDate": "2023-11-07T05:31:56Z",
        "ownerMembershipId": "<string>",
        "pdfURL": "<string>",
        "receiptPdfURL": "<string>",
        "memo": "<string>",
        "bankPaymentOnly": true,
        "type": "purchase",
        "currency": "USD",
        "taxAmount": 123,
        "subtotal": 123,
        "taxType": "amusement_tax",
        "taxCountry": "AF",
        "taxState": "<string>",
        "taxRatePercentage": "<string>",
        "applicationFee": 123
      },
      "invoiceLineItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "invoiceId": "<string>",
          "quantity": 123,
          "priceId": "<string>",
          "description": "<string>",
          "price": 123
        }
      ]
    }
  ],
  "paymentMethods": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "billingDetails": {
        "name": "<string>",
        "email": "<string>",
        "address": {
          "name": "<string>",
          "address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          }
        }
      },
      "type": "card",
      "default": true,
      "paymentMethodData": {},
      "metadata": {}
    }
  ],
  "purchases": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "name": "<string>",
      "status": "open",
      "customerId": "<string>",
      "organizationId": "<string>",
      "billingCycleAnchor": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "quantity": 123,
      "priceType": "subscription",
      "trialPeriodDays": 123,
      "pricePerBillingCycle": 123,
      "intervalUnit": "day",
      "intervalCount": 123,
      "firstInvoiceValue": 123,
      "totalPurchaseValue": "<any>",
      "bankPaymentOnly": true,
      "purchaseDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "proposal": "<string>",
      "archived": true,
      "billingAddress": "<string>",
      "metadata": {}
    }
  ],
  "currentSubscriptions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "trialing",
      "defaultPaymentMethodId": "<string>",
      "backupPaymentMethodId": "<string>",
      "trialEnd": "2023-11-07T05:31:56Z",
      "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
      "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
      "metadata": {},
      "canceledAt": "2023-11-07T05:31:56Z",
      "cancelScheduledAt": "2023-11-07T05:31:56Z",
      "priceId": "<string>",
      "runBillingAtPeriodStart": true,
      "interval": "day",
      "intervalCount": 123,
      "billingCycleAnchorDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "current": true,
      "subscriptionItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "subscriptionId": "<string>",
          "name": "<string>",
          "addedDate": "2023-11-07T05:31:56Z",
          "priceId": "<string>",
          "unitPrice": 123,
          "quantity": 123,
          "metadata": {},
          "price": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        }
      ]
    }
  ],
  "catalog": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "organizationId": "<string>",
    "isDefault": true,
    "name": "<string>",
    "products": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "livemode": true,
        "name": "<string>",
        "description": "<string>",
        "imageURL": "<string>",
        "organizationId": "<string>",
        "displayFeatures": [
          {
            "enabled": true,
            "label": "<string>",
            "details": "<string>"
          }
        ],
        "active": true,
        "singularQuantityLabel": "<string>",
        "pluralQuantityLabel": "<string>",
        "catalogId": "<string>",
        "prices": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "productId": "<string>",
            "active": true,
            "currency": "USD"
          }
        ],
        "defaultPrice": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "livemode": true,
          "intervalUnit": "day",
          "name": "<string>",
          "intervalCount": 123,
          "type": "subscription",
          "trialPeriodDays": 123,
          "setupFeeAmount": 123,
          "isDefault": true,
          "unitPrice": 123,
          "productId": "<string>",
          "active": true,
          "currency": "USD"
        }
      }
    ]
  }
}

API Documentation

Payments

Checkout Sessions

Products

Prices

Customer

Discounts

Invoice Line Items

Invoices

Catalogs

Subscriptions

PaymentMethods

UsageEvents

Authorizations

Path Parameters

Response