Invoice past due

Headers

webhook-signature

string

required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp

string

required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json

string

required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

api_version

string

required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

timestamp

string<date-time>

required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

type

string

required

The webhook event type

Allowed value: "invoice.past_due"

Example:

"invoice.past_due"

data

object

required

A statement that defines an amount due by a customer.

Show child attributes

data.id

string

required

The ID of the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

data.created_at

string<date-time>

required

The date the invoice was created.

Example:

"2023-12-01T05:00:00.401Z"

data.status

enum<string>

required

The status of the invoice.

Available options:

open,

paid,

past_due,

void

data.number

string

required

The number of the invoice.

Example:

"#0001"

data.due_date

string<date-time> | null

required

The date the invoice is due.

Example:

"2023-12-01T05:00:00.401Z"

data.email_address

string | null

required

The email address that the invoice was created for.

Example:

"[email protected]"

data.fetch_invoice_token

string

required

A signed token that allows fetching the invoice data publically without being authenticated.

data.current_plan

object

required

The plan that the invoice was created for.

Show child attributes

data.current_plan.id

string

required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

data.current_plan.formatted_price

string

required

The formatted price (including currency) for the plan.

Example:

"$10.00"

data.current_plan.currency

enum<string>

required

The respective currency identifier for the plan.

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny

data.user

object

required

The user that the invoice was created for.

Show child attributes

data.user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

Response

200

Return a 200 status to indicate that the data was received successfully

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Headers

Body

Response