General
Core API
Customer Portal API
Webhook Events
Integrations
order.refunded
Sent when an order is fully or partially refunded.
Discord & Slack support: Full
"order.refunded"Show child attributes
Show child attributes
The ID of the object.
Creation timestamp of the object.
Last modification timestamp of the object.
pending, paid, refunded, partially_refunded Whether the order has been paid for.
Amount in cents, before discounts and taxes.
Discount amount in cents.
Amount in cents, after discounts but before taxes.
Sales tax amount in cents.
Amount in cents, after discounts and taxes.
Customer's balance amount applied to this invoice. Can increase the total amount paid, if the customer has a negative balance, or decrease it, if the customer has a positive balance.Amount in cents.
Amount in cents that is due for this order.
Amount refunded in cents.
Sales tax refunded in cents.
purchase, subscription_create, subscription_cycle, subscription_update The name of the customer that should appear on the invoice.
Show child attributes
Show child attributes
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW The invoice number associated with this order.
Whether an invoice has been generated for this order.
Platform fee amount in cents.
Show child attributes
Show child attributes
The ID of the customer.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.
"usr_1337"
The email address of the customer. This must be unique within the organization.
Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
The name of the customer.
"John Doe"
Show child attributes
Show child attributes
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW 2 elements["911144442", "us_ein"]
The ID of the organization owning the customer.
Timestamp for when the customer was soft deleted.
Show child attributes
Show child attributes
The ID of the object.
Creation timestamp of the object.
Last modification timestamp of the object.
The interval unit for the trial period.
day, week, month, year The number of interval units for the trial period.
The name of the product.
The description of the product.
The recurring interval of the product. If None, the product is a one-time purchase.
day, week, month, year Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
Whether the product is a subscription.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
- DiscountFixedOnceForeverDurationBase
- DiscountFixedRepeatDurationBase
- DiscountPercentageOnceForeverDurationBase
- DiscountPercentageRepeatDurationBase
Show child attributes
Show child attributes
once, forever, repeating fixed, percentage Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Name of the discount. Will be displayed to the customer when the discount is applied.
Code customers can use to apply the discount during checkout.
Timestamp after which the discount is redeemable.
Timestamp after which the discount is no longer redeemable.
Maximum number of times the discount can be redeemed.
Number of times the discount has been redeemed.
The organization ID.
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
The amount of the subscription.
The currency of the subscription.
The interval at which the subscription recurs.
day, week, month, year Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.
The status of the subscription.
incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid The start timestamp of the current billing period.
The end timestamp of the current billing period.
The start timestamp of the trial period, if any.
The end timestamp of the trial period, if any.
Whether the subscription will be canceled at the end of the current period.
The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.
The timestamp when the subscription started.
The timestamp when the subscription will end.
The timestamp when the subscription ended.
The ID of the subscribed customer.
The ID of the subscribed product.
The ID of the applied discount, if any.
customer_service, low_quality, missing_features, switched_service, too_complex, too_expensive, unused, other The number of seats for seat-based subscriptions. None for non-seat subscriptions.
Line items composing the order.
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Description of the line item charge.
Amount in cents, before discounts and taxes.
Sales tax amount in cents.
Whether this charge is due to a proration.
Associated price ID, if any.
A summary description of the order.
Number of seats purchased (for seat-based one-time orders).
Was this page helpful?
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"data": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"status": "pending",
"paid": true,
"subtotal_amount": 123,
"discount_amount": 123,
"net_amount": 123,
"tax_amount": 123,
"total_amount": 123,
"applied_balance_amount": 123,
"due_amount": 123,
"refunded_amount": 123,
"refunded_tax_amount": 123,
"currency": "<string>",
"billing_reason": "purchase",
"billing_name": "<string>",
"billing_address": {
"country": "AD",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>"
},
"invoice_number": "<string>",
"is_invoice_generated": true,
"customer_id": "<string>",
"product_id": "<string>",
"discount_id": "<string>",
"subscription_id": "<string>",
"checkout_id": "<string>",
"metadata": {},
"platform_fee_amount": 123,
"customer": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"metadata": {},
"external_id": "usr_1337",
"email": "<string>",
"email_verified": true,
"name": "John Doe",
"billing_address": {
"country": "AD",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>"
},
"tax_id": [
"911144442",
"us_ein"
],
"organization_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"avatar_url": "<string>"
},
"user_id": "<string>",
"product": {
"metadata": {},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"trial_interval": "day",
"trial_interval_count": 123,
"name": "<string>",
"description": "<string>",
"recurring_interval": "day",
"recurring_interval_count": 123,
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>"
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 123,
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"name": "<string>",
"code": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"max_redemptions": 123,
"redemptions_count": 123,
"organization_id": "<string>"
},
"subscription": {
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount": 123,
"currency": "<string>",
"recurring_interval": "day",
"recurring_interval_count": 123,
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"trial_start": "2023-11-07T05:31:56Z",
"trial_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"product_id": "<string>",
"discount_id": "<string>",
"checkout_id": "<string>",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "<string>",
"seats": 123
},
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"label": "<string>",
"amount": 123,
"tax_amount": 123,
"proration": true,
"product_price_id": "<string>"
}
],
"description": "<string>",
"seats": 123,
"custom_field_data": {}
}
}