Skip to main content

UpdateSubscriptionInput

Input for updateSubscription.

input UpdateSubscriptionInput {
  amount: Int
  intervalCount: Int
  interval: IntervalInput
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  callbackUrl: String
  paymentCallbackUrl: String
  customer: CustomerInput
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  nextPaymentAt: AWSTimestamp
  trialPeriodEnd: AWSTimestamp
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  id: ID!
  retrySchedule: [RetryScheduleInput!]
  metadata: [KeyValueInput!]
}

Fields

`UpdateSubscriptionInput.amount` ● `Int` scalar

A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

`UpdateSubscriptionInput.intervalCount` ● `Int` scalar

Number of intervals between subscription payments. Total period must not exceed one year.

`UpdateSubscriptionInput.interval` ● `IntervalInput` enum

Subscription interval. The minute and hour intervals are only available in test mode.

`UpdateSubscriptionInput.allowedPaymentMethods` ● `[SubscriptionPaymentMethods]` list enum

List of payment methods allowed for subscriptions.

`UpdateSubscriptionInput.description` ● `String` scalar

An arbitrary string attached to the subscription. Often useful for displaying to users.

`UpdateSubscriptionInput.descriptor` ● `String` scalar

Statement descriptor shown on the customer's bank statement.

`UpdateSubscriptionInput.callbackUrl` ● `String` scalar

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

`UpdateSubscriptionInput.paymentCallbackUrl` ● `String` scalar

The URL will be called each time subscription creates a new payment. You will receive the payment object in the body of the request.

`UpdateSubscriptionInput.customer` ● `CustomerInput` input

Customer details.

`UpdateSubscriptionInput.billingDetails` ● `ContactDetailsInput` input

Billing details.

`UpdateSubscriptionInput.shippingDetails` ● `ContactDetailsInput` input

Shipping details.

`UpdateSubscriptionInput.nextPaymentAt` ● `AWSTimestamp` scalar

Reschedule the next charge to this time. Measured in seconds since the Unix epoch.

`UpdateSubscriptionInput.trialPeriodEnd` ● `AWSTimestamp` scalar

The end date of the trial period. Measured in seconds since the Unix epoch.

`UpdateSubscriptionInput.cancelAtPeriodEnd` ● `Boolean` scalar

If true, the subscription will be canceled at the end of the current period.

`UpdateSubscriptionInput.pauseIntervalCount` ● `Int` scalar

Number of intervals when subscription will be paused before it activates again.

`UpdateSubscriptionInput.pauseAtPeriodEnd` ● `Boolean` scalar

If true, the subscription will be paused at the end of the current period.

`UpdateSubscriptionInput.skipIntervalCount` ● `Int` scalar

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status.

`UpdateSubscriptionInput.id` ● `ID!` non-null scalar

Unique identifier for the subscription to update.

`UpdateSubscriptionInput.retrySchedule` ● `[RetryScheduleInput!]` list input

Defines a custom schedule for retrying failed subscription payments. Total retry duration must not exceed one billing period.

`UpdateSubscriptionInput.metadata` ● `[KeyValueInput!]` list input

A set of key-value pairs attached to the subscription. Set a value to null to remove the key.

Member Of

updateSubscription mutation

Fields
Member Of