Skip to main content

ActivateSubscriptionRequest

paymentTokenPayment-PaymentToken (string)

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.

Example: 7cc38b08ff471ccd313ad62b23b9f362b107560b
sessionIdPayment-SessionId (string)

A unique identifier within your system that adds security to the payment process. You need to pass the same session ID as the one used on the frontend to initialize MONEI Component (if you needed to). This is required if a payment token (not permanent) was already generated in the frontend.

Example: 39603551437913
addAmountint32

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).

Example: 110
sequenceIdPayment-SequenceId (string)

A permanent identifier that refers to the initial payment of a sequence of payments. This value needs to be sent in the path for RECURRING payments.

Example: 62b23b9f3627cc38b08ff471ccd313ad
completeUrlPayment-CompleteUrl (string)

The URL the customer will be directed to after transaction completed (successful or failed - except if failUrl is provided).

Example: https://example.com/checkout/complete
failUrlPayment-FailUrl (string)

The URL the customer will be directed to after transaction has failed, instead of completeUrl (used in hosted payment page). This allows to provide two different URLs for successful and failed payments.

Example: https://example.com/checkout/fail
cancelUrlPayment-CancelUrl (string)

The URL the customer will be directed to if they decide to cancel payment and return to your website (used in hosted payment page).

Example: https://example.com/checkout/cancel
metadataobject

A set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.

Example: {"systemId":"12345"}
ActivateSubscriptionRequest
{
  "paymentToken": "7cc38b08ff471ccd313ad62b23b9f362b107560b",
  "sessionId": "39603551437913",
  "addAmount": 110,
  "sequenceId": "62b23b9f3627cc38b08ff471ccd313ad",
  "completeUrl": "https://example.com/checkout/complete",
  "failUrl": "https://example.com/checkout/fail",
  "cancelUrl": "https://example.com/checkout/cancel",
  "metadata": {
    "systemId": "12345"
  }
}