HubSpot: GDPR Delete — commerce Subscriptions gdpr Delete
HubSpot commerceSubscriptions.gdprDelete: arguments, response, policy and SDK examples.
← Commerce subscriptions operations · Get started
Operation hubspot.commerce_subscriptions_gdpr_delete
Provider route: POST /crm/objects/2026-09/subscriptions/gdpr-delete. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["commerceSubscriptions"]["gdprDelete"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.commerceSubscriptions.gdprDelete(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.commerce_subscriptions.gdpr_delete(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand GDPR Delete — commerce Subscriptions gdpr Delete — request body — body |
Referenced models: GDPR Delete — commerce Subscriptions gdpr Delete — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root |
Schemas
Section titled “Schemas”GDPR Delete — commerce Subscriptions gdpr Delete — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An input that contains the information required to process a public GDPR data deletion request. |
idProperty | string | Optional | An optional property that specifies the unique property name used to identify the object, such as 'email'. If provided, the object will be identified by this property instead of the default object ID. |
objectId | string | Required within parent | The unique identifier of the object to be deleted. This is a required field and must be a string. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.commerce_subscriptions_gdpr_delete. Catalog operation: commerce_subscriptions_gdpr_delete. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["crm.objects.subscriptions.write"]
No-content response statuses: [204]