Skip to main content

ActivateSubscriptionInput

Input for activateSubscription. Generates the initial payment that establishes the recurring mandate.

input ActivateSubscriptionInput {
  paymentToken: String
  addAmount: Int
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  sequenceId: ID
  sessionId: ID
  completeUrl: String
  cancelUrl: String
  failUrl: String
  id: ID!
  metadata: [KeyValueInput!]
  expireAt: AWSTimestamp
}

Fields

`ActivateSubscriptionInput.paymentToken` ● `String` scalar

A payment token generated by monei.js Components or a paymentToken saved after a previous successful payment. In case of the first one, you will also need to send the sessionId used to generate the token in the first place.

`ActivateSubscriptionInput.addAmount` ● `Int` scalar

The amount to be added to the subscription's initial payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

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

List of payment methods allowed for this activation payment.

`ActivateSubscriptionInput.sequenceId` ● `ID` scalar

A unique identifier representing a series of subsequent recurring payments (e.g. when migrating).

`ActivateSubscriptionInput.sessionId` ● `ID` scalar

Existing payment session ID to reuse.

`ActivateSubscriptionInput.completeUrl` ● `String` scalar

The URL the customer is redirected to after a successful payment.

`ActivateSubscriptionInput.cancelUrl` ● `String` scalar

The URL the customer is redirected to when they cancel the payment.

`ActivateSubscriptionInput.failUrl` ● `String` scalar

The URL the customer is redirected to after a failed payment.

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

Unique identifier for the subscription to activate.

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

A set of key-value pairs merged into the payment metadata.

`ActivateSubscriptionInput.expireAt` ● `AWSTimestamp` scalar

Activation payment expiration. Measured in seconds since the Unix epoch. Cannot exceed trialPeriodEnd minus a 15-minute safety buffer.

Member Of

activateSubscription mutation

Fields
Member Of