Webhooks
Webhook Events
Features
- Products
- Benefits
- Checkout
- Discounts
- Orders & Subscriptions
- Refunds
- Analytics
- Customer Management
- Customer Portal
- Finance & Payouts
- Integrations
Integrate
- Authentication
- Sandbox Environment
- SDKs
- Webhooks
- Framework Guides
- OAuth 2.0
Merchant of Record (MoR)
Webhooks
Webhook Events
All our webhook events and their payload samples.
Billing Events
Checkout
checkout.created
Sent when a new checkout is created.
Discord & Slack support: Basic
Payload Sample
{
"type": "checkout.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"payment_processor": "stripe",
"status": "open",
"client_secret": "string",
"url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"success_url": "string",
"embed_origin": "string",
"amount": 50,
"tax_amount": 0,
"currency": "string",
"subtotal_amount": 0,
"total_amount": 0,
"product_id": "string",
"product_price_id": "string",
"discount_id": "string",
"allow_discount_codes": true,
"is_discount_applicable": true,
"is_free_product_price": true,
"is_payment_required": true,
"is_payment_setup_required": true,
"is_payment_form_required": true,
"customer_id": "string",
"customer_name": "string",
"customer_email": "string",
"customer_ip_address": "string",
"customer_billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"customer_tax_id": "string",
"payment_processor_metadata": {
"property1": "string",
"property2": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"products": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "custom",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string"
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
]
}
],
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "custom",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string"
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
]
},
"product_price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"id": "string",
"name": "string",
"code": "string"
},
"subscription_id": "string",
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
],
"customer_metadata": {
"property1": "string",
"property2": "string"
}
}
}
checkout.updated
Sent when a checkout is updated.
Discord & Slack support: Basic
Payload Sample
{
"type": "checkout.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"payment_processor": "stripe",
"status": "open",
"client_secret": "string",
"url": "string",
"expires_at": "2019-08-24T14:15:22Z",
"success_url": "string",
"embed_origin": "string",
"amount": 50,
"tax_amount": 0,
"currency": "string",
"subtotal_amount": 0,
"total_amount": 0,
"product_id": "string",
"product_price_id": "string",
"discount_id": "string",
"allow_discount_codes": true,
"is_discount_applicable": true,
"is_free_product_price": true,
"is_payment_required": true,
"is_payment_setup_required": true,
"is_payment_form_required": true,
"customer_id": "string",
"customer_name": "string",
"customer_email": "string",
"customer_ip_address": "string",
"customer_billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"customer_tax_id": "string",
"payment_processor_metadata": {
"property1": "string",
"property2": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"products": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "custom",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string"
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
]
}
],
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "custom",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string"
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
]
},
"product_price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"id": "string",
"name": "string",
"code": "string"
},
"subscription_id": "string",
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
],
"customer_metadata": {
"property1": "string",
"property2": "string"
}
}
}
Subscriptions
In order to properly implement logic for handling subscriptions, you should look into the following events.
Fired when a new subscription has been created.
Use this event if you want to handle cancellations, un-cancellations, etc. The updated event is a catch-all event for subscription.active , subscription.canceled , subscription.uncanceled & subscription.revoked
In case you want to do logic when a subscription is renewed, you should listen to order.created and the billing_reason field. It can be purchase , subscription_create , subscription_cycle & subscription_update . subscription_cycle is used when subscriptions renew.
subscription.created
Sent when a new subscription is created.
Discord & Slack support: Full
Payload Sample
{
"type": "subscription.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
subscription.active
Sent when a subscription becomes active, whether because it’s a new paid subscription or because payment was recovered.
Discord & Slack support: Full
Payload Sample
{
"type": "subscription.active",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
subscription.updated
Sent when a subscription is updated. This event fires for all changes to the subscription, including renewals.
If you want more specific events, you can listen to subscription.active, subscription.canceled, and subscription.revoked.
To listen specifically for renewals, you can listen to order.created events and check the billing_reason field.
Discord & Slack support: On cancellation and revocation. Renewals are skipped.
Payload Sample
{
"type": "subscription.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
subscription.canceled
Sent when a subscription is canceled. Customers might still have access until the end of the current period.
Discord & Slack support: Full
Payload Sample
{
"type": "subscription.canceled",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
subscription.uncanceled
Sent when a subscription is uncanceled.
Discord & Slack support: Full
Payload Sample
{
"type": "subscription.uncanceled",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
subscription.revoked
Sent when a subscription is revoked, the user looses access immediately. Happens when the subscription is canceled, or payment is past due.
Discord & Slack support: Full
Payload Sample
{
"type": "subscription.revoked",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
},
"price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
}
}
}
Order
order.created
Sent when a new order is created.
Discord & Slack support: Full
Payload Sample
{
"type": "order.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"status": "string",
"amount": 0,
"tax_amount": 0,
"refunded_amount": 0,
"refunded_tax_amount": 0,
"currency": "string",
"billing_reason": "purchase",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"customer_id": "string",
"product_id": "string",
"product_price_id": "string",
"discount_id": "string",
"subscription_id": "string",
"checkout_id": "string",
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string"
},
"product_price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
},
"subscription": {
"metadata": {
"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"user_id": "string"
}
}
}
order.refunded
Sent when an order is fully or partially refunded.
Discord & Slack support: Full
Payload Sample
{
"type": "order.refunded",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"custom_field_data": {
"property1": "string",
"property2": "string"
},
"status": "string",
"amount": 0,
"tax_amount": 0,
"refunded_amount": 0,
"refunded_tax_amount": 0,
"currency": "string",
"billing_reason": "purchase",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"customer_id": "string",
"product_id": "string",
"product_price_id": "string",
"discount_id": "string",
"subscription_id": "string",
"checkout_id": "string",
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"user_id": "string",
"user": {
"id": "string",
"email": "string",
"public_name": "string",
"avatar_url": "string",
"github_username": "string"
},
"product": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string"
},
"product_price": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 0,
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"code": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"max_redemptions": 0,
"redemptions_count": 0,
"organization_id": "string"
},
"subscription": {
"metadata": {
"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount": 0,
"currency": "string",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"cancel_at_period_end": true,
"canceled_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"ended_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"product_id": "string",
"price_id": "string",
"discount_id": "string",
"checkout_id": "string",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "string",
"user_id": "string"
}
}
}
Refunds
refund.created
Sent when a refund is created regardless of status.
Discord & Slack support: Full
Payload Sample
{
"type": "refund.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "pending",
"reason": "duplicate",
"amount": 0,
"tax_amount": 0,
"currency": "string",
"organization_id": "string",
"order_id": "string",
"subscription_id": "string",
"customer_id": "string",
"revoke_benefits": true
}
}
refund.updated
Sent when a refund is updated.
Discord & Slack support: Full
Payload Sample
{
"type": "refund.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"status": "pending",
"reason": "duplicate",
"amount": 0,
"tax_amount": 0,
"currency": "string",
"organization_id": "string",
"order_id": "string",
"subscription_id": "string",
"customer_id": "string",
"revoke_benefits": true
}
}
Benefit Grants
benefit_grant.created
Sent when a new benefit grant is created.
Discord & Slack support: Basic
Payload Sample
{
"type": "benefit_grant.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"granted_at": "2019-08-24T14:15:22Z",
"is_granted": true,
"revoked_at": "2019-08-24T14:15:22Z",
"is_revoked": true,
"subscription_id": "string",
"order_id": "string",
"customer_id": "string",
"user_id": "string",
"benefit_id": "string",
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
},
"benefit": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
},
"previous_properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
}
}
}
benefit_grant.updated
Sent when a new benefit grant is updated.
Discord & Slack support: Basic
Payload Sample
{
"type": "benefit_grant.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"granted_at": "2019-08-24T14:15:22Z",
"is_granted": true,
"revoked_at": "2019-08-24T14:15:22Z",
"is_revoked": true,
"subscription_id": "string",
"order_id": "string",
"customer_id": "string",
"user_id": "string",
"benefit_id": "string",
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
},
"benefit": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
},
"previous_properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
}
}
}
benefit_grant.revoked
Sent when a new benefit grant is revoked.
Discord & Slack support: Basic
Payload Sample
{
"type": "benefit_grant.revoked",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"granted_at": "2019-08-24T14:15:22Z",
"is_granted": true,
"revoked_at": "2019-08-24T14:15:22Z",
"is_revoked": true,
"subscription_id": "string",
"order_id": "string",
"customer_id": "string",
"user_id": "string",
"benefit_id": "string",
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"email": "string",
"email_verified": true,
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax_id": [
"string",
"ad_nrt"
],
"organization_id": "string",
"avatar_url": "string"
},
"properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
},
"benefit": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
},
"previous_properties": {
"account_id": "string",
"guild_id": "string",
"role_id": "string"
}
}
}
Organization Events
Benefits
benefit.created
Sent when a new benefit is created.
Discord & Slack support: Basic
Payload Sample
{
"type": "benefit.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
}
benefit.updated
Sent when a benefit is updated.
Discord & Slack support: Basic
Payload Sample
{
"type": "benefit.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
}
Products
product.created
Sent when a new product is created.
Discord & Slack support: Basic
Payload Sample
{
"type": "product.created",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
}
}
product.updated
Sent when a product is updated.
Discord & Slack support: Basic
Payload Sample
{
"type": "product.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"description": "string",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"prices": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"amount_type": "fixed",
"is_archived": true,
"product_id": "string",
"type": "recurring",
"recurring_interval": "month",
"price_currency": "string",
"price_amount": 0,
"legacy": true
}
],
"benefits": [
{
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"type": "ads",
"description": "string",
"selectable": true,
"deletable": true,
"organization_id": "string",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "string",
"organization_id": "string",
"name": "string",
"path": "string",
"mime_type": "string",
"size": 0,
"storage_version": "string",
"checksum_etag": "string",
"checksum_sha256_base64": "string",
"checksum_sha256_hex": "string",
"last_modified_at": "2019-08-24T14:15:22Z",
"version": "string",
"service": "product_media",
"is_uploaded": true,
"created_at": "2019-08-24T14:15:22Z",
"size_readable": "string",
"public_url": "string"
}
],
"attached_custom_fields": [
{
"custom_field_id": "string",
"custom_field": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"type": "text",
"slug": "string",
"name": "string",
"organization_id": "string",
"properties": {
"form_label": "string",
"form_help_text": "string",
"form_placeholder": "string",
"textarea": true,
"min_length": 0,
"max_length": 0
}
},
"order": 0,
"required": true
}
]
}
}
Organization
organization.updated
Sent when a organization is updated.
Discord & Slack support: Basic
Payload Sample
{
"type": "organization.updated",
"data": {
"created_at": "2019-08-24T14:15:22Z",
"modified_at": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"slug": "string",
"avatar_url": "string",
"bio": "string",
"company": "string",
"blog": "string",
"location": "string",
"email": "string",
"twitter_username": "string",
"pledge_minimum_amount": 0,
"pledge_badge_show_amount": true,
"default_upfront_split_to_contributors": 0,
"profile_settings": {
"enabled": true,
"description": "string",
"featured_projects": [
"string"
],
"featured_organizations": [
"string"
],
"links": [
"http://example.com"
],
"subscribe": {
"promote": true,
"show_count": true,
"count_free": true
},
"accent_color": "string"
},
"feature_settings": {
"issue_funding_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"allow_customer_updates": true,
"proration_behavior": "invoice"
}
}
}
Was this page helpful?
On this page
- Billing Events
- Checkout
- checkout.created
- checkout.updated
- Subscriptions
- subscription.created
- subscription.active
- subscription.updated
- subscription.canceled
- subscription.uncanceled
- subscription.revoked
- Order
- order.created
- order.refunded
- Refunds
- refund.created
- refund.updated
- Benefit Grants
- benefit_grant.created
- benefit_grant.updated
- benefit_grant.revoked
- Organization Events
- Benefits
- benefit.created
- benefit.updated
- Products
- product.created
- product.updated
- Organization
- organization.updated