CreateSubscriptionInput

No description

input CreateSubscriptionInput {
  amount: Int!
  trialAmount: Int
  currency: Currencies
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  customer: CustomerInput
  billingDetails: ContactDetailsInput
  shippingDetails: ContactDetailsInput
  interval: IntervalInput
  intervalCount: Int
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  callbackUrl: String
  paymentCallbackUrl: String
  storeId: ID
  retrySchedule: [RetryScheduleInput!]
  metadata: [KeyValueInput!]
}

Fields

CreateSubscriptionInput.amount ● Int! non-null scalar

The amount to be charged

CreateSubscriptionInput.trialAmount ● Int scalar

The amount to be charged during the trial period

CreateSubscriptionInput.currency ● Currencies enum

The currency of the payment

CreateSubscriptionInput.allowedPaymentMethods ● [SubscriptionPaymentMethods] list enum

Which payment methods are allowed

CreateSubscriptionInput.description ● String scalar

The payment description

CreateSubscriptionInput.descriptor ● String scalar

The payment descriptor

CreateSubscriptionInput.customer ● CustomerInput input

Basic information about the customer

CreateSubscriptionInput.billingDetails ● ContactDetailsInput input

Billing information

CreateSubscriptionInput.shippingDetails ● ContactDetailsInput input

Shipping details

CreateSubscriptionInput.interval ● IntervalInput enum

Subscription interval

CreateSubscriptionInput.intervalCount ● Int scalar

Number of intervals between subscription payments

CreateSubscriptionInput.trialPeriodDays ● Int scalar

Number of days the trial period lasts

CreateSubscriptionInput.trialPeriodEnd ● AWSTimestamp scalar

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

CreateSubscriptionInput.callbackUrl ● String scalar

The URL where to notify a success payment

CreateSubscriptionInput.paymentCallbackUrl ● String scalar

The URL will be called each time subscription creates a new payments

CreateSubscriptionInput.storeId ● ID scalar

Related Store

CreateSubscriptionInput.retrySchedule ● [RetryScheduleInput!] list input

Custom retry schedule

CreateSubscriptionInput.metadata ● [KeyValueInput!] list input

Custom metadata

Member Of

createSubscription mutation