Delete a Subscription Event

DELETE https://api.chartmogul.com/v1/subscription_events

Deletes a subscription event using either the subscription event external ID and data source UUID or the subscription event ID.

curl -X DELETE "https://api.chartmogul.com/v1/subscription_events" \
     -u YOUR_API_KEY: \
     -H "Content-Type: application/json" \
     -d '{
            "subscription_event":
              {
                "external_id": "evnt_0001",
                "data_source_uuid": "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c"
              }
        }'
ChartMogul::SubscriptionEvent.destroy_with_params!({
  subscription_event: {
    external_id: "evnt_0001",
    data_source_uuid: "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c",
  },
})
ChartMogul.SubscriptionEvent.deleteWithParams(config, {
  subscription_event: {
    external_id: "evnt_0001",
    data_source_uuid: "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c",
  },
});
ChartMogul\SubscriptionEvent::destroyWithParams([
  "subscription_event" => [
    "external_id" => "evnt_0001",
    "data_source_uuid" => "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c"
  ]
]);
api.DeleteSubscriptionEvent(
  &cm.DeleteSubscriptionEvent{
    DataSourceUUID: "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c",
    ExternalID:     "evnt_0001",
  },
)
chartmogul.SubscriptionEvent.destroy_with_params(
  config,
  data={
    "subscription_event": {
      "external_id": "evnt_0001",
      "data_source_uuid": "ds_14336c0c-ab0b-11ec-8c55-c3902af70e1c",
    }
  },
)
{}
true
{}
true
nil
None

Impact of this action. This request will delete the specified subscription event. Metrics for the customer will be recalculated based on the billing data remaining after this action.

For automatic sources (Stripe, Chargebee, Recurly, Braintree, Google Play and App Store Connect), a deleted subscription event may be restored during a resync. To permanently remove a subscription event from an automatic source, you can disable it.

For other sources, deleting a subscription event is permanent.

Body parameters

To delete the subscription event, the required parameters are either:

external_id string required
A unique identifier specified by you for the subscription event. Typically an identifier from your internal system.
data_source_uuid string required
The ChartMogul unique identifier for the source where the subscription event is being added.
id integer required
The ChartMogul UUID of a subscription event.