General
Core API
Customer Portal API
Webhook Events
Integrations
subscription.revoked
Sent when a subscription is revoked, the user loses access immediately. Happens when the subscription is canceled, or payment is past due.
Discord & Slack support: Full
"subscription.revoked"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 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.
A product.
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.
List of prices for this product.
A recurring price for a product, i.e. a subscription.
Deprecated: The recurring interval should be set on the product itself.
- LegacyRecurringProductPriceFixed
- LegacyRecurringProductPriceCustom
- LegacyRecurringProductPriceFree
- ProductPriceFixed
- ProductPriceCustom
- ProductPriceFree
- ProductPriceSeatBased
- ProductPriceMeteredUnit
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the price.
The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.
catalog, ad_hoc "fixed"Whether the price is archived and no longer available.
The ID of the product owning the price.
The type of the price.
"recurring"The recurring interval of the price.
day, week, month, year The currency.
The price in cents.
List of benefits granted by the product.
A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
- BenefitCustom
- BenefitDiscord
- BenefitGitHubRepository
- BenefitDownloadables
- BenefitLicenseKeys
- BenefitMeterCredit
Show child attributes
Show child attributes
The ID of the benefit.
Creation timestamp of the object.
Last modification timestamp of the object.
"custom"The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
The ID of the organization owning the benefit.
List of medias associated to the product.
Show child attributes
Show child attributes
The ID of the object.
"product_media"List of custom fields attached to the product.
Show child attributes
Show child attributes
ID of the custom field.
Schema for a custom field of type text.
- CustomFieldText
- CustomFieldNumber
- CustomFieldDate
- CustomFieldCheckbox
- CustomFieldSelect
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"text"Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
Show child attributes
Show child attributes
111x >= 0x >= 0Order of the custom field in the resource.
Whether the value is required for this custom field.
- 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.
List of enabled prices for the subscription.
A recurring price for a product, i.e. a subscription.
Deprecated: The recurring interval should be set on the product itself.
- LegacyRecurringProductPriceFixed
- LegacyRecurringProductPriceCustom
- LegacyRecurringProductPriceFree
- ProductPriceFixed
- ProductPriceCustom
- ProductPriceFree
- ProductPriceSeatBased
- ProductPriceMeteredUnit
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the price.
The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.
catalog, ad_hoc "fixed"Whether the price is archived and no longer available.
The ID of the product owning the price.
The type of the price.
"recurring"The recurring interval of the price.
day, week, month, year The currency.
The price in cents.
List of meters associated with the subscription.
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
The number of consumed units so far in this billing period.
The number of credited units so far in this billing period.
The amount due in cents so far in this billing period.
The ID of the meter.
The meter associated with this subscription.
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
The name of the meter. Will be shown on customer's invoices and usage.
The filter to apply on events that'll be used to calculate the meter.
Show child attributes
Show child attributes
and, or The ID of the organization owning the meter.
Whether the meter is archived and the time it was archived.
The number of seats for seat-based subscriptions. None for non-seat subscriptions.
Was this page helpful?
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"data": {
"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>",
"metadata": {},
"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>"
},
"product": {
"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>",
"metadata": {},
"prices": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"source": "catalog",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "day",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
}
],
"benefits": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"type": "<string>",
"description": "<string>",
"selectable": true,
"deletable": true,
"organization_id": "<string>",
"metadata": {},
"properties": {
"note": "<string>"
}
}
],
"medias": [
{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"path": "<string>",
"mime_type": "<string>",
"size": 123,
"storage_version": "<string>",
"checksum_etag": "<string>",
"checksum_sha256_base64": "<string>",
"checksum_sha256_hex": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"version": "<string>",
"service": "<string>",
"is_uploaded": true,
"created_at": "2023-11-07T05:31:56Z",
"size_readable": "<string>",
"public_url": "<string>"
}
],
"attached_custom_fields": [
{
"custom_field_id": "<string>",
"custom_field": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"organization_id": "<string>",
"properties": {
"form_label": "<string>",
"form_help_text": "<string>",
"form_placeholder": "<string>",
"textarea": true,
"min_length": 1,
"max_length": 1
}
},
"order": 123,
"required": true
}
]
},
"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>"
},
"prices": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"source": "catalog",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "day",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
}
],
"meters": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"consumed_units": 123,
"credited_units": 123,
"amount": 123,
"meter_id": "<string>",
"meter": {
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"filter": {
"conjunction": "and",
"clauses": [
{
"property": "<string>",
"operator": "eq",
"value": "<string>"
}
]
},
"aggregation": {
"func": "count"
},
"organization_id": "<string>",
"archived_at": "2023-11-07T05:31:56Z"
}
}
],
"seats": 123,
"custom_field_data": {}
}
}