PauseSubscriptionInput

Input for pauseSubscription.

input PauseSubscriptionInput {
  pauseIntervalCount: Int!
  pauseAtPeriodEnd: Boolean
  id: ID!
}

Fields

PauseSubscriptionInput.pauseIntervalCount ● Int! non-null scalar

Number of billing periods to pause, from 1 to 31. The next payment moves that many billing periods later.

PauseSubscriptionInput.pauseAtPeriodEnd ● Boolean scalar

If true, the subscription stays ACTIVE until the end of the current period and is paused then. If false or omitted, it is paused at once.

PauseSubscriptionInput.id ● ID! non-null scalar

ID of the subscription to pause.

Member Of

pauseSubscription mutation