{
  "account_name": "ShedRx Sand",
  "amount_due": 19900,
  "amount_paid": 19900,
  "amount_remaining": 0,
  "billing_reason": "subscription_cycle",
  "charge_id": "ch_3TTWJ9GbiXBLOAVo1zkDONz8",
  "collection_method": "charge_automatically",
  "created_at": null,
  "currency": "usd",
  "customer_email": "customer@example.com",
  "customer_id": "cus_U4jwaMRwkP6qLr",
  "customer_name": "John Doe",
  "effective_at": null,
  "hosted_invoice_url": "https://invoice.stripe.com/i/acct_123/test_abc",
  "id": "in_1TTVMkGbiXBLOAVo4jKaboGP",
  "invoice_pdf": "https://pay.stripe.com/invoice/acct_123/test_abc/pdf",
  "line_items": [
    {
      "amount": 19900,
      "currency": "usd",
      "description": "1 × TEST GLP1 (at $199.00 / month)",
      "id": "il_1TTVLnGbiXBLOAVoultZ5tAh",
      "period_end": null,
      "period_start": null,
      "price_id": "price_1T6aUFGbiXBLOAVoLmslGAvA",
      "product_id": "prod_U4jyPVoMBzHL9i",
      "proration": false,
      "quantity": 1
    }
  ],
  "number": "K7UI7HTV-0008",
  "paid": true,
  "payment_intent_id": "pi_3TTWJ9GbiXBLOAVo1tGehQBT",
  "period_end": null,
  "period_start": null,
  "status": "paid",
  "subscription_id": "sub_1T7OHLGbiXBLOAVoJWWh8tqP",
  "subtotal": 19900,
  "total": 19900
}

{
  "account_name": "Name of the Stripe account",
  "amount_due": "Total amount due in cents",
  "amount_paid": "Amount already paid in cents",
  "amount_remaining": "Remaining unpaid amount in cents",
  "billing_reason": "Reason the invoice was created (e.g. subscription_create, subscription_cycle)",
  "charge_id": "The charge associated with payment",
  "collection_method": "How the invoice is collected (charge_automatically or send_invoice)",
  "created_at": "When the invoice was created",
  "currency": "Three-letter ISO currency code",
  "customer_email": "Customer's email address",
  "customer_id": "Stripe customer ID",
  "customer_name": "Customer's full name",
  "effective_at": "When the invoice was finalized",
  "hosted_invoice_url": "URL for the hosted invoice page",
  "id": "Unique identifier for the Stripe invoice",
  "invoice_pdf": "URL for the invoice PDF",
  "line_items": {
    "amount": "Amount in cents",
    "currency": "Three-letter ISO currency code",
    "description": "Description of the line item",
    "id": "Unique identifier for the line item",
    "period_end": "End of the line item period",
    "period_start": "Start of the line item period",
    "price_id": "ID of the price object",
    "product_id": "ID of the product",
    "proration": "Whether this is a proration line item",
    "quantity": "Quantity of the line item"
  },
  "number": "A unique, identifying string displayed on the invoice",
  "paid": "Whether payment was successfully collected for this invoice",
  "payment_intent_id": "The payment intent for this invoice",
  "period_end": "End of the billing period",
  "period_start": "Start of the billing period",
  "status": "Status of the invoice",
  "subscription_id": "The subscription this invoice belongs to",
  "subtotal": "Total before any discounts or taxes in cents",
  "total": "Total after discounts and taxes in cents"
}

Events

Triggering Webhook Types

The following event types are associated with the Invoice event payload from Stripe.

Stripe Invoice Payment Succeeded
Stripe Invoice Payment Failed
Stripe Invoice Created
Stripe Invoice Finalized

{
  "account_name": "ShedRx Sand",
  "amount_due": 19900,
  "amount_paid": 19900,
  "amount_remaining": 0,
  "billing_reason": "subscription_cycle",
  "charge_id": "ch_3TTWJ9GbiXBLOAVo1zkDONz8",
  "collection_method": "charge_automatically",
  "created_at": null,
  "currency": "usd",
  "customer_email": "customer@example.com",
  "customer_id": "cus_U4jwaMRwkP6qLr",
  "customer_name": "John Doe",
  "effective_at": null,
  "hosted_invoice_url": "https://invoice.stripe.com/i/acct_123/test_abc",
  "id": "in_1TTVMkGbiXBLOAVo4jKaboGP",
  "invoice_pdf": "https://pay.stripe.com/invoice/acct_123/test_abc/pdf",
  "line_items": [
    {
      "amount": 19900,
      "currency": "usd",
      "description": "1 × TEST GLP1 (at $199.00 / month)",
      "id": "il_1TTVLnGbiXBLOAVoultZ5tAh",
      "period_end": null,
      "period_start": null,
      "price_id": "price_1T6aUFGbiXBLOAVoLmslGAvA",
      "product_id": "prod_U4jyPVoMBzHL9i",
      "proration": false,
      "quantity": 1
    }
  ],
  "number": "K7UI7HTV-0008",
  "paid": true,
  "payment_intent_id": "pi_3TTWJ9GbiXBLOAVo1tGehQBT",
  "period_end": null,
  "period_start": null,
  "status": "paid",
  "subscription_id": "sub_1T7OHLGbiXBLOAVoJWWh8tqP",
  "subtotal": 19900,
  "total": 19900
}

{
  "account_name": "Name of the Stripe account",
  "amount_due": "Total amount due in cents",
  "amount_paid": "Amount already paid in cents",
  "amount_remaining": "Remaining unpaid amount in cents",
  "billing_reason": "Reason the invoice was created (e.g. subscription_create, subscription_cycle)",
  "charge_id": "The charge associated with payment",
  "collection_method": "How the invoice is collected (charge_automatically or send_invoice)",
  "created_at": "When the invoice was created",
  "currency": "Three-letter ISO currency code",
  "customer_email": "Customer's email address",
  "customer_id": "Stripe customer ID",
  "customer_name": "Customer's full name",
  "effective_at": "When the invoice was finalized",
  "hosted_invoice_url": "URL for the hosted invoice page",
  "id": "Unique identifier for the Stripe invoice",
  "invoice_pdf": "URL for the invoice PDF",
  "line_items": {
    "amount": "Amount in cents",
    "currency": "Three-letter ISO currency code",
    "description": "Description of the line item",
    "id": "Unique identifier for the line item",
    "period_end": "End of the line item period",
    "period_start": "Start of the line item period",
    "price_id": "ID of the price object",
    "product_id": "ID of the product",
    "proration": "Whether this is a proration line item",
    "quantity": "Quantity of the line item"
  },
  "number": "A unique, identifying string displayed on the invoice",
  "paid": "Whether payment was successfully collected for this invoice",
  "payment_intent_id": "The payment intent for this invoice",
  "period_end": "End of the billing period",
  "period_start": "Start of the billing period",
  "status": "Status of the invoice",
  "subscription_id": "The subscription this invoice belongs to",
  "subtotal": "Total before any discounts or taxes in cents",
  "total": "Total after discounts and taxes in cents"
}

Payload Field Details

Event Payload

Hide fields

string

required

Unique identifier for the Stripe invoice

CEL

id

Example

"in_1TTVMkGbiXBLOAVo4jKaboGP"

string

Status of the invoice

CEL

status

Example

"paid"

string

Reason the invoice was created (e.g. subscription_create, subscription_cycle)

CEL

billing_reason

Example

"subscription_cycle"

int64

Total amount due in cents

CEL

amount_due

Example

int64

Amount already paid in cents

CEL

amount_paid

Example

int64

Remaining unpaid amount in cents

CEL

amount_remaining

Example

string

Three-letter ISO currency code

CEL

currency

Example

"usd"

string

Stripe customer ID

CEL

customer_id

Example

"cus_U4jwaMRwkP6qLr"

string

Customer’s email address

CEL

customer_email

Example

"customer@example.com"

string

Customer’s full name

CEL

customer_name

Example

"John Doe"

string

The subscription this invoice belongs to

CEL

subscription_id

Example

"sub_1T7OHLGbiXBLOAVoJWWh8tqP"

string

The payment intent for this invoice

CEL

payment_intent_id

Example

"pi_3TTWJ9GbiXBLOAVo1tGehQBT"

string

The charge associated with payment

CEL

charge_id

Example

"ch_3TTWJ9GbiXBLOAVo1zkDONz8"

string

A unique, identifying string displayed on the invoice

CEL

number

Example

"K7UI7HTV-0008"

bool

Whether payment was successfully collected for this invoice

CEL

paid

Example

true

int64

Total before any discounts or taxes in cents

CEL

subtotal

Example

int64

Total after discounts and taxes in cents

CEL

total

Example

string

URL for the hosted invoice page

CEL

hosted_invoice_url

Example

"https://invoice.stripe.com/i/acct_123/test_abc"

string

URL for the invoice PDF

CEL

invoice_pdf

Example

"https://pay.stripe.com/invoice/acct_123/test_abc/pdf"

timing.v1.Timestamp

When the invoice was created

CEL

created_at

Example

null

timing.v1.Timestamp

When the invoice was finalized

CEL

effective_at

Example

null

timing.v1.Timestamp

Start of the billing period

CEL

period_start

Example

null

timing.v1.Timestamp

End of the billing period

CEL

period_end

Example

null

[]object

required

Line items on the invoice

CEL

line_items

Example

[
{
"amount": 19900,
"currency": "usd",
"description": "1 × TEST GLP1 (at $199.00 / month)",
"id": "il_1TTVLnGbiXBLOAVoultZ5tAh",
"period_end": null,
"period_start": null,
"price_id": "price_1T6aUFGbiXBLOAVoLmslGAvA",
"product_id": "prod_U4jyPVoMBzHL9i",
"proration": false,
"quantity": 1
}
]

[]string

required

Mapped array of: Unique identifier for the line item

CEL

line_items.map(x, x.id)

Example

[
"il_1TTVLnGbiXBLOAVoultZ5tAh"
]

[]int64

required

Mapped array of: Amount in cents

CEL

line_items.map(x, x.amount)

Example

[
19900
]

[]string

required

Mapped array of: Three-letter ISO currency code

CEL

line_items.map(x, x.currency)

Example

[
"usd"
]

[]string

required

Mapped array of: Description of the line item

CEL

line_items.map(x, x.description)

Example

[
"1 × TEST GLP1 (at $199.00 / month)"
]

[]int64

required

Mapped array of: Quantity of the line item

CEL

line_items.map(x, x.quantity)

Example

[
1
]

[]string

required

Mapped array of: ID of the price object

CEL

line_items.map(x, x.price_id)

Example

[
"price_1T6aUFGbiXBLOAVoLmslGAvA"
]

[]string

required

Mapped array of: ID of the product

CEL

line_items.map(x, x.product_id)

Example

[
"prod_U4jyPVoMBzHL9i"
]

[]timing.v1.Timestamp

required

Mapped array of: Start of the line item period

CEL

line_items.map(x, x.period_start)

Example

[
null
]

[]timing.v1.Timestamp

required

Mapped array of: End of the line item period

CEL

line_items.map(x, x.period_end)

Example

[
null
]

[]bool

required

Mapped array of: Whether this is a proration line item

CEL

line_items.map(x, x.proration)

Example

[
false
]

string

How the invoice is collected (charge_automatically or send_invoice)

CEL

collection_method

Example

"charge_automatically"

string

Name of the Stripe account

CEL

account_name

Example

"ShedRx Sand"

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details