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

Amount added to the activation payment, as a positive integer in the smallest currency unit (e.g., 100 cents to charge 1.00 USD). With a trial and no trialAmount, it is the amount of the verification. Ignored for an ACTIVE subscription.

ActivateSubscriptionInput.allowedPaymentMethods ● [SubscriptionPaymentMethods] list enum

List of payment methods allowed for this activation payment. Defaults to allowedPaymentMethods of the subscription.

ActivateSubscriptionInput.sequenceId ● ID scalar

Ignored.

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

ID of the subscription to activate.

ActivateSubscriptionInput.metadata ● [KeyValueInput!] list input

Key-value pairs to add to the subscription metadata on the activation payment. A call that sets this field fails validation.

ActivateSubscriptionInput.expireAt ● AWSTimestamp scalar

Activation payment expiration. Measured in seconds since the Unix epoch. When the subscription has a trial end date, it defaults to and cannot exceed trialPeriodEnd minus 15 minutes (no margin for a subscription billed every minute).

Member Of

activateSubscription mutation