Skip to main content

UpdateAccessTierInput

Fields to update on an access tier. All fields are optional; omitted fields are left unchanged.

input UpdateAccessTierInput {
  name: String
  tierOrder: Int
  isFree: Boolean
  isDefault: Boolean
  priceCents: BigInt
  currency: String
  billingPeriod: String
  description: String
  stripePriceId: String
  paypalPlanId: String
  permissionKeys: [String!]
  applyCommunicationDefaults: Boolean
}

Fields​

UpdateAccessTierInput.name ● String scalar​

New tier name (max 128 chars).

UpdateAccessTierInput.tierOrder ● Int scalar​

New sort order (ascending).

UpdateAccessTierInput.isFree ● Boolean scalar​

Set whether the tier is free.

UpdateAccessTierInput.isDefault ● Boolean scalar​

Set whether this is the app's default tier.

UpdateAccessTierInput.priceCents ● BigInt scalar​

New price in cents; null clears the price (makes the tier unpriced).

UpdateAccessTierInput.currency ● String scalar​

New ISO 4217 currency code (e.g. "usd").

UpdateAccessTierInput.billingPeriod ● String scalar​

New billing cadence (e.g. "month", "year"); null clears it.

UpdateAccessTierInput.description ● String scalar​

New tier description; null clears it.

UpdateAccessTierInput.stripePriceId ● String scalar​

External Stripe price id to associate (billing integration).

UpdateAccessTierInput.paypalPlanId ● String scalar​

External PayPal plan id to associate (billing integration).

UpdateAccessTierInput.permissionKeys ● [String!] list scalar​

Replacement set of runtime permission keys for the tier (must be valid runtimePermissions). When provided, replaces the existing set entirely.

UpdateAccessTierInput.applyCommunicationDefaults ● Boolean scalar​

With permissionKeys: when true (the default) and the new set grants access, it also grants use_text_chat and use_direct_messages, whether or not permissionKeys names them. Pass false to set exactly permissionKeys, for example to take text chat away. Ignored without permissionKeys.

Member Of​

updateAccessTier mutation