For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LoginStart trialGet a demo
  • Welcome
    • Getting Started
    • Create an API Key
    • Pagination
    • Rate Limiting
    • No-Code Integrations
  • Webhooks
      • POSTSubscription Created
      • POSTSubscription Confirmed
      • POSTSubscription Deleted
      • POSTSubscription Upgraded
      • POSTSubscription Downgraded
      • POSTSubscription Paused
      • POSTSubscription Resumed
      • POSTSubscription Tier Paused
      • POSTSubscription Tier Resumed
      • POSTSubscription Tier Added
      • POSTSubscription Tier Deleted
  • OAuth2
  • API Reference
LogoLogo
LoginStart trialGet a demo
WebhooksSubscription

Subscription Upgraded

Payload
1{
2  "data": {
3    "created": 1666800076,
4    "email": "[email protected]",
5    "id": "sub_00000000-0000-0000-0000-000000000000",
6    "referral_code": "ABC123",
7    "referring_site": "https://www.blog.com",
8    "status": "active",
9    "subscription_tier": "premium",
10    "subscription_premium_tier_names": [
11      "Premium",
12      "Pro"
13    ],
14    "stripe_customer_id": "cus_00000000000000",
15    "utm_campaign": "Q1 Campaign",
16    "utm_channel": "website",
17    "utm_medium": "organic",
18    "utm_source": "Twitter",
19    "custom_fields": [
20      {
21        "name": "Newsletter Preference",
22        "kind": "boolean",
23        "value": "true"
24      },
25      {
26        "name": "Company",
27        "kind": "string",
28        "value": "Acme Corp"
29      }
30    ],
31    "tags": [
32      "VIP",
33      "Newsletter"
34    ]
35  },
36  "event_timestamp": 1666800076,
37  "event_type": "subscription.upgraded",
38  "uid": "evt_00000000-0000-0000-0000-000000000000"
39}
Was this page helpful?
Previous

Subscription Downgraded

Next
Built with

Payload

The payload of this webhook request is an object.
dataobjectOptional
event_timestampintegerOptional
The date the event was created. Measured in seconds since the Unix epoch.
event_typestringOptional
The event type.
uidstringOptional
The prefixed event ID, unique to each webhook event.

Response

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