Saltar al contenido principal

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!
  prorate: Boolean
  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). Without prorate, the new amount applies from the next payment. A Bizum subscription cannot change it.

UpdateSubscriptionInput.intervalCount ● Int scalar​

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

UpdateSubscriptionInput.interval ● IntervalInput enum​

New unit of the billing period.

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​

URL that receives a POST request with the subscription object each time the status changes or a payment retry is scheduled.

UpdateSubscriptionInput.paymentCallbackUrl ● String scalar​

Callback URL set on each payment the subscription creates. It receives the payment object.

UpdateSubscriptionInput.customer ● CustomerInput input​

Customer details.

UpdateSubscriptionInput.billingDetails ● ContactDetailsInput input​

Billing details.

UpdateSubscriptionInput.shippingDetails ● ContactDetailsInput input​

Shipping details.

UpdateSubscriptionInput.nextPaymentAt ● AWSTimestamp scalar​

Moves the next payment to this time, and the end of the current billing period with it. Later payments follow on from this date. Measured in seconds since the Unix epoch. Only an ACTIVE or PAST_DUE subscription accepts it; on a PAST_DUE one, it stops the retries. Must be in the future and not more than 5 years from now. Fails while a skip, a pause or a cancellation at period end is scheduled; clear it in the same request. The dashboard calls it "Next charge date".

UpdateSubscriptionInput.trialPeriodEnd ● AWSTimestamp scalar​

The end date of the trial period. Measured in seconds since the Unix epoch. Must be in the future and not more than 5 years from now. On a TRIALING subscription, the next payment and the end of the current period move to this date.

UpdateSubscriptionInput.cancelAtPeriodEnd ● Boolean scalar​

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

UpdateSubscriptionInput.pauseIntervalCount ● Int scalar​

Number of billing periods to stay paused, from 1 to 31. On a PAUSED subscription, the next payment moves to that many billing periods after the end of the current period. Set to null to clear it.

UpdateSubscriptionInput.pauseAtPeriodEnd ● Boolean scalar​

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

UpdateSubscriptionInput.skipIntervalCount ● Int scalar​

Number of upcoming payments to skip, from 0 to 31. On an ACTIVE subscription, the next payment moves that many billing periods later. 0 or null clears a scheduled skip. Not accepted on a PENDING, PAUSED or CANCELED subscription. The dashboard action is "Skip next payment".

UpdateSubscriptionInput.id ● ID! non-null scalar​

ID of the subscription to update.

UpdateSubscriptionInput.prorate ● Boolean scalar​

Settles the change at once: on an ACTIVE subscription, a change to amount, interval, intervalCount or nextPaymentAt is charged or partially refunded now. See previewSubscriptionUpdate. On a TRIALING subscription, the change applies without a charge or refund. Other statuses fail. The dashboard calls it "Apply the change now".

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​

Replaces all metadata of the subscription with these key-value pairs. A null value fails validation.

Member Of​

updateSubscription mutation

Última actualización en