Skip to main content
Archives a credit type (custom currency), preventing it from being used for new credit grants.
Archive and unarchive operations for credit types are currently available via the GraphQL API only. REST API support is not yet available.

​
Archive Mutation

mutation ArchiveCreditType($input: ArchiveCreditTypeInput!) {
  archiveCreditType(input: $input) {
    id
    status
  }
}

​
Archive Parameters

​
input
ArchiveCreditTypeInput
required
Input for archiving a credit type
It is not possible to archive a credit type that is in use by an active published plan or add-on. Remove the credit type from those plans and add-ons first, then publish the updated versions before archiving.

​
Behavior

When a credit type is archived:
  • Customers with an existing credit pool of this type can still view it and consume credits normally. Granting additional credits to the pool is not possible.
  • Customers without a credit pool of this type cannot see it or receive credits from it.
  • The credit type cannot be used in new plans or add-ons.
Archiving is a soft operation — all credit pool data is retained.

​
Unarchive Mutation

mutation UnarchiveCreditType($input: UnarchiveCreditTypeInput!) {
  unarchiveCreditType(input: $input) {
    id
    status
  }
}

​
Unarchive Parameters

​
input
UnarchiveCreditTypeInput
required
Input for unarchiving a credit type