Skip to main content
Archives a customer, preventing new subscriptions and optionally canceling existing ones.

​
Mutation

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

​
Parameters

​
input
ArchiveCustomerInput
required
Input for archiving a customer

​
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

Archive customer when they request account deletion.
Archive customers flagged for fraudulent activity.
Archive customers who have churned and won’t return.