subscriptions/upgrade

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Triggered when a customer upgrades their subscription to a higher-tier plan, providing information about the new subscription details.

Sample payload

{
  "id": "e1f2g3h4-i5j6-k7l8-m9n0-o1p2q3r4s5t6",
  "plan": {
    "id": "75cbecd2-660c-4944-985a-9f739f6d230e",
    "name": "Enterprise Plan",
    "amount": 199.99,
    "public": true,
    "features": {
      "custom_reports": {
        "id": "8fca5ac8-6b79-4411-92cd-46d9560479c9",
        "name": "Custom Reports",
        "type": "boolean",
        "value": true,
        "description": "Generate detailed analytics reports",
        "displayOrder": 1
      },
      "api_calls": {
        "id": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
        "name": "API Calls",
        "type": "limit_with_overage",
        "value": "50000",
        "description": "Monthly API call limit",
        "displayOrder": 2
      },
      "user_seats": {
        "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
        "name": "User Seats",
        "type": "limit",
        "value": "25",
        "description": "Number of team members who can access",
        "displayOrder": 3
      },
      "priority_support": {
        "id": "d1e2f3g4-h5i6-j7k8-l9m0-n1o2p3q4r5",
        "name": "Priority Support",
        "type": "boolean",
        "value": true,
        "description": "24/7 dedicated support team",
        "displayOrder": 4
      }
    },
    "interval": "EVERY_30_DAYS",
    "createdAt": "2025-01-10T11:15:22.819Z",
    "trialDays": 0,
    "updatedAt": "2025-03-17T09:30:12.345Z",
    "description": "Enterprise-grade features for high-volume businesses",
    "currencyCode": "USD",
    "customFields": {
      "Recommended": "false",
      "EnterpriseOnly": "true"
    },
    "usageCharges": [
      {
        "id": "c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6",
        "type": "unit",
        "terms": null,
        "amount": 0.003,
        "eventName": null,
        "cappedAmount": 500
      }
    ],
    "featuresOrder": [
      "custom_reports",
      "api_calls",
      "user_seats",
      "priority_support"
    ]
  },
  "topic": "subscriptions/upgrade",
  "active": true,
  "shopify": {
    "id": "gid://shopify/AppSubscription/46312987542"
  },
  "cancelOn": null,
  "customer": {
    "id": "g1h2i3j4-k5l6-m7n8-o9p0-q1r2s3t4u5v6",
    "name": "Mountain Commerce",
    "tags": [
      "enterprise",
      "high-volume"
    ],
    "test": false,
    "email": "[email protected]",
    "shopify": {
      "id": "82345678901",
      "isPlus": true,
      "shopId": "82345678901",
      "planName": "Shopify Plus",
      "isDevPlan": false,
      "myshopifyDomain": "mountain-commerce.myshopify.com"
    },
    "platformId": "82345678901",
    "installedAt": "2025-01-15T08:42:11.000Z",
    "billingStatus": "active",
    "lifetimeValue": 599.97,
    "trialStartsAt": null,
    "uninstalledAt": null,
    "trialExpiresAt": null,
    "averageMonthlyRevenue": 199.99
  },
  "features": {
    "custom_reports": {
      "id": "8fca5ac8-6b79-4411-92cd-46d9560479c9",
      "name": "Custom Reports",
      "type": "boolean",
      "value": true,
      "description": "Generate detailed analytics reports",
      "displayOrder": 1
    },
    "api_calls": {
      "id": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
      "name": "API Calls",
      "type": "limit_with_overage",
      "value": "50000",
      "description": "Monthly API call limit",
      "displayOrder": 2
    },
    "user_seats": {
      "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "name": "User Seats",
      "type": "limit",
      "value": "25",
      "description": "Number of team members who can access",
      "displayOrder": 3
    },
    "priority_support": {
      "id": "d1e2f3g4-h5i6-j7k8-l9m0-n1o2p3q4r5",
      "name": "Priority Support",
      "type": "boolean",
      "value": true,
      "description": "24/7 dedicated support team",
      "displayOrder": 4
    }
  },
  "frozenAt": null,
  "createdAt": "2025-03-18T15:12:33.789Z",
  "canceledAt": null,
  "activatedAt": "2025-03-18T15:12:45.123Z",
  "usageCharges": [
    {
      "id": "c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6",
      "type": "unit",
      "terms": null,
      "amount": 0.003,
      "eventName": null,
      "cappedAmount": 500
    }
  ],
  "featuresOrder": [
    "custom_reports",
    "api_calls",
    "user_seats",
    "priority_support"
  ],
  "confirmationUrl": "https://mountain-commerce.myshopify.com/admin/charges/145283456789/46312987542/RecurringApplicationCharge/confirm_recurring_application_charge?signature=BAh7BzoHaWRsKwgT9dC2CwA6EmF1dG9fYWN0aXZhdGVU--8d4e7bf21598a3c64fd7b9e72a1c4e5d9b876543",
  "currentPeriodEnd": "2025-04-18T15:12:45.123Z",
  "usageBalanceUsed": 199.99,
  "usageCappedAmount": 2000,
  "currentPeriodStart": "2025-03-18T15:12:45.123Z",
  "shopifySubscription": {
    "id": "gid://shopify/AppSubscription/46312987542"
  }
}
{
  "id": "sub_E1f2G3h4I5j6K7l8",
  "plan": {
    "id": "price_1P2xZjLpM7KT5gH3n0VqS2Rb",
    "name": "Enterprise Plan",
    "amount": 199.99,
    "public": true,
    "features": {
      "custom_reports": {
        "id": "feat_cr_8fca5ac86b79",
        "name": "Custom Reports",
        "type": "boolean",
        "value": true,
        "description": "Generate detailed analytics reports",
        "displayOrder": 1
      },
      "api_calls": {
        "id": "feat_api_b1c2d3e4f5g6",
        "name": "API Calls",
        "type": "limit_with_overage",
        "value": "50000",
        "description": "Monthly API call limit",
        "displayOrder": 2
      },
      "user_seats": {
        "id": "feat_us_a1b2c3d4e5f6",
        "name": "User Seats",
        "type": "limit",
        "value": "25",
        "description": "Number of team members who can access",
        "displayOrder": 3
      },
      "priority_support": {
        "id": "feat_ps_d1e2f3g4h5i6",
        "name": "Priority Support",
        "type": "boolean",
        "value": true,
        "description": "24/7 dedicated support team",
        "displayOrder": 4
      }
    },
    "interval": "month",
    "createdAt": "2025-01-10T11:15:22.819Z",
    "trialDays": 0,
    "updatedAt": "2025-03-17T09:30:12.345Z",
    "description": "Enterprise-grade features for high-volume businesses",
    "currencyCode": "USD",
    "customFields": {
      "Recommended": "false",
      "EnterpriseOnly": "true"
    },
    "usageCharges": [
      {
        "id": "uc_c1d2e3f4g5h6i7j8",
        "type": "unit",
        "terms": null,
        "amount": 0.003,
        "eventName": null,
        "cappedAmount": 500
      }
    ],
    "featuresOrder": [
      "custom_reports",
      "api_calls",
      "user_seats",
      "priority_support"
    ],
    "stripe": {
      "id": "price_1P2xZjLpM7KT5gH3n0VqS2Rb",
      "createdAt": "2025-01-10T11:15:22.819Z"
    }
  },
  "topic": "subscriptions/upgrade",
  "active": true,
  "cancelOn": null,
  "customer": {
    "id": "cus_G1h2I3j4K5l6M7n8",
    "name": "Mountain Commerce",
    "tags": [
      "enterprise",
      "high-volume"
    ],
    "test": false,
    "email": "[email protected]",
    "platformId": "82345678901",
    "installedAt": "2025-01-15T08:42:11.000Z",
    "billingStatus": "active",
    "lifetimeValue": 599.97,
    "trialStartsAt": null,
    "uninstalledAt": null,
    "trialExpiresAt": null,
    "averageMonthlyRevenue": 199.99
  },
  "features": {
    "custom_reports": {
      "id": "feat_cr_8fca5ac86b79",
      "name": "Custom Reports",
      "type": "boolean",
      "value": true,
      "description": "Generate detailed analytics reports",
      "displayOrder": 1
    },
    "api_calls": {
      "id": "feat_api_b1c2d3e4f5g6",
      "name": "API Calls",
      "type": "limit_with_overage",
      "value": "50000",
      "description": "Monthly API call limit",
      "displayOrder": 2
    },
    "user_seats": {
      "id": "feat_us_a1b2c3d4e5f6",
      "name": "User Seats",
      "type": "limit",
      "value": "25",
      "description": "Number of team members who can access",
      "displayOrder": 3
    },
    "priority_support": {
      "id": "feat_ps_d1e2f3g4h5i6",
      "name": "Priority Support",
      "type": "boolean",
      "value": true,
      "description": "24/7 dedicated support team",
      "displayOrder": 4
    }
  },
  "frozenAt": null,
  "createdAt": "2025-03-18T15:12:33.789Z",
  "canceledAt": null,
  "activatedAt": "2025-03-18T15:12:45.123Z",
  "usageCharges": [
    {
      "id": "uc_c1d2e3f4g5h6i7j8",
      "type": "unit",
      "terms": null,
      "amount": 0.003,
      "eventName": null,
      "cappedAmount": 500
    }
  ],
  "featuresOrder": [
    "custom_reports",
    "api_calls",
    "user_seats",
    "priority_support"
  ],
  "confirmationUrl": null,
  "currentPeriodEnd": "2025-04-18T15:12:45.123Z",
  "usageBalanceUsed": 199.99,
  "usageCappedAmount": 2000,
  "currentPeriodStart": "2025-03-18T15:12:45.123Z",
  "stripe": {
    "id": "sub_E1f2G3h4I5j6K7l8",
    "createdAt": "2025-03-18T15:12:33.789Z"
  }
}
Body Params

A subscription was upgraded

string

The topic of the webhook

subscription
object
Response
200

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

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!