Archive Customer

Archives a customer, preventing new subscriptions and optionally canceling existing ones.

Mutation

Mutation

mutation ArchiveCustomer($input: ArchiveCustomerInput!) {
  archiveCustomer(input: $input) {
    customerId
  }
}

{
  "input": {
    "customerId": "customer-123"
  }
}

{
  "data": {
    "archiveCustomer": {
      "customerId": "customer-123"
    }
  }
}

Parameters

input · ArchiveCustomerInput · required

Input for archiving a customer

Show properties

customerId · String · required

The customer’s reference ID

environmentId · UUID

Environment ID

Return Type

Returns the archived Customer object with the customerId.

Behavior

When a customer is archived:

1. All active subscriptions are canceled
2. Customer cannot create new subscriptions
3. Entitlement checks return CustomerIsArchived as access denied reason
4. Customer data is retained but marked as deleted

Unarchive Customer

To restore an archived customer:

mutation UnarchiveCustomer($input: UnarchiveCustomerInput!) {
  unarchiveCustomer(input: $input) {
    customerId
    name
    email
  }
}

Common Use Cases

Account deletion

Archive customer when they request account deletion.

Fraud prevention

Archive customers flagged for fraudulent activity.

Churn handling

Archive customers who have churned and won’t return.

Related Operations

• Update Customer - Modify customer
• Cancel Subscription - Cancel individual subscription