Disable a Subscription Event

PATCH https://api.chartmogul.com/v1/subscription_event/disable

Disables or enables a subscription event in sources that support disabling records.

curl -X PATCH "https://api.chartmogul.com/v1/subscription_events/123456/disabled_state" \
     -u YOUR_API_KEY: \
     -H "Content-Type: application/json" \
     -d '{
            "disabled": true
          }'

{
  "id": 23223966,
  "data_source_uuid": "ds_1fm3eaac-62d0-31ec-clf4-4bf0mbe81aba",
  "customer_external_id": "scus_001",
  "subscription_set_external_id": null,
  "subscription_external_id": "sub_0001",
  "plan_external_id": "gold_monthly",
  "event_date": "2024-03-30T00:00:00Z",
  "effective_date": "2024-04-30T00:00:00Z",
  "event_type": "subscription_start_scheduled",
  "external_id": "evnt_001",
  "errors": {},
  "created_at": "2024-03-31T14:30:48Z",
  "updated_at": "2024-04-12T09:58:06Z",
  "quantity": 1,
  "currency": "USD",
  "amount_in_cents": "100",
  "tax_amount_in_cents": 0,
  "event_order": 100,
  "retracted_event_id": null,
  "disabled": true,
  "disabled_at": "2025-08-03T22:59:43.698Z",  
  "disabled_by": "[email protected]",
  "user_created": false
}

Behavior with different types of sources. This endpoint is meant for use with Stripe, Chargebee, Recurly or Braintree (the latest version of the integration), which allow you to disable records.

Trying to disable a subscription event in any other source will return an error. You can delete the subscription event instead.

External ID requirement. It’s only possible to disable a subscription event with an external ID. ChartMogul needs this information to associate your edits with the edited record.

Path parameters

id integer required: The unique identifier for the subscription event generated by ChartMogul.

Body parameters

disabled boolean required: Specifies whether a subscription event should be disabled or enabled. Set this to true to disable a subscription event. Set this to false to enable a previously disabled subscription event.

Response

The response contains the subscription event object:

id: The unique identifier for the subscription event generated by ChartMogul.
data_source_uuid: The unique identifier for the source where the subscription event has been added, generated by ChartMogul.
customer_external_id: The unique identifier for the customer associated with this subscription event. Typically an identifier from your internal system.
subscription_set_external_id: A reference identifier for a set of subscriptions used to group several subscriptions into one set. Returns null if no subscription set is associated.
subscription_external_id: The unique identifier for the subscription to which the subscription event has been added. Typically an identifier from your internal system.
plan_external_id: The unique identifier for the plan associated with this subscription event. Typically an identifier from your internal system.
event_date: The date and time when this event was raised as an ISO 8601-formatted string.
effective_date: The date and time when this event takes effect as an ISO 8601-formatted string.
event_type: The type of subscription event that was created. One of: subscription_start, subscription_start_scheduled, scheduled_subscription_start_retracted, subscription_cancelled, subscription_cancellation_scheduled, scheduled_subscription_cancellation_retracted, subscription_updated, subscription_update_scheduled, scheduled_subscription_update_retracted or subscription_event_retracted.
external_id: The unique identifier for the subscription event specified in the request.
errors: An object containing any validation errors that occurred during the creation of the subscription event.
created_at: The date and time when the subscription event was created in ChartMogul as an ISO 8601-formatted string.
updated_at: The date and time when the subscription event was last updated in ChartMogul as an ISO 8601-formatted string.
quantity: The quantity of subscriptions associated with this subscription event.
currency: The three-letter currency code of the currency in which this subscription is being billed.
amount_in_cents: The final amount charged towards this subscription, after discounts, taxes and fees have been applied, expressed in cents.
tax_amount_in_cents: The tax amount in cents that has been applied to the subscription addressed by this subscription event.
event_order: The order in which simultaneous events for a subscription are processed. Returns null if no specific order was specified.
retracted_event_id: The event ID of the scheduled subscription event that is being retracted. Returns null for non-retraction events.
disabled: A boolean stating whether or not the subscription event was disabled.
disabled_at: The date and time when the subscription event was disabled (null for non-disabled records).
disabled_by: The email address of the user who disabled the subscription event (null for non-disabled records).
user_created: A boolean stating whether or not the subscription event was created by the user for sources like Stripe, Chargebee, Recurly and Braintree (the latest version of the integration).