Skip to main content

UpdateSubscriptionInput

Autogenerated input type of UpdateSubscription

input UpdateSubscriptionInput {
  clientMutationId: String
  companyId: ID!
  planName: String
  status: BillingSubscriptionStatusEnum
  trialEnd: ISO8601DateTime
}

Fields​

UpdateSubscriptionInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

UpdateSubscriptionInput.companyId ● ID! non-null scalar common​

The company (party) whose subscription to update.

UpdateSubscriptionInput.planName ● String scalar common​

Stable name of the EC plan to switch to (e.g. "growth"), or null to clear the plan. Editable only while unsynced; rejected once provider-synced — change the plan in the provider (e.g. Stripe) instead. Omit to leave it unchanged.

UpdateSubscriptionInput.status ● BillingSubscriptionStatusEnum enum billing​

The subscription status. Editable only while unsynced; rejected once a provider subscription is linked (the provider then drives status). Omit to leave unchanged.

UpdateSubscriptionInput.trialEnd ● ISO8601DateTime scalar common​

When the trial ends, or null to clear it. Editable only while unsynced (rejected once a provider subscription is linked). While unsynced, setting it moves the subscription to trialing and clearing it returns it to initialized unless a status is also given. Omit to leave it unchanged.

Member Of​

updateSubscription mutation