Subscription details

If you provide subscription services, it's important to understand that the properties required in your API requests vary depending on the subscription model you choose. These models can range, each coming with specific requirements.

No trial period

In this model, a consumer begins their subscription by making a payment. The total amount is charged regularly at specified intervals (every few days, weeks, months, or annually). As soon as a customer subscribes, they are billed for the total subscription cost for the chosen period, and this billing cycle repeats at the end of each period unless the subscription is canceled.

Free trial

This subscription model allows consumers to start with a specified period during which they are not charged. The duration of this free trial is predetermined and clearly communicated. After completing this trial period, the consumer automatically starts getting charged the regular subscription costs.

Discount trial offer

Consumers initially receive a discounted rate for a set period of time when they start their subscription. It means subscribers pay less than the standard subscription price for the duration of this defined period, using the same services at a reduced cost. After this period ends, the subscription cost reverts to the normal rate.

Discount trial offer, paid fully upfront

When a consumer starts their subscription, they pay the entire trial period cost at a discounted rate upfront. It means the subscriber makes a one-time payment at the beginning of their subscription, covering the whole duration of the trial at a lower price. After the trial period ends, regular billing will start according to the standard subscription terms.

Scenarios

No trial period – a consumer initiates the subscription and pays the total amount every X number of days/weeks/months/quarters/years.

- hostedCheckoutSpecificInput.isRecurring (set to true)
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.intervalFrequency
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.interval
- order.amountOfMoney (the amount consumer will be paying)

POST HOSTEDCHECKOUTS REQUEST

{
        "order": {
          "amountOfMoney": {
            "currencyCode": "EUR",
            "amount": 2345
          },
          "customer": {
              "merchantCustomerId":89769876,
            "billingAddress": {
                 
              "countryCode": "NL"
            }
          }
        },
        "hostedCheckoutSpecificInput": {
          "isRecurring": true,
          "recurringPaymentsData": {
              "recurringInterval":{
                  "intervalFrequency": "1",
                  "interval": "weeks"
              }
          },
          "variant": "testVariant",
          "locale": "en_GB"
        }
      }

Free trial – a consumer initiates a subscription with a specified free-of-charge period. After that period, the consumer starts to pay the subscription amount.

- hostedCheckoutSpecificInput.isRecurring (set to true)
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.intervalFrequency
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.interval order.amountOfMoney (set to zero)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.amountOfMoneyAfterTrial (the amount that the cardholder will be paying after the free trial)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.endDate OR hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.trialPeriod

TRIAL END DATE REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 0
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
           
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "endDate": "20300201",
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    },
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

free-trial-with-end-date-checkout-screen

TRIAL PERIOD REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 0
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
          
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "trialPeriod": {
            "duration":20,
            "interval":"days"
        },
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    }, 
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

free-trial-with-trial-period-checkout-screen

Discount trial offer – subscription starts with a discount applied to X period of time.
- hostedCheckoutSpecificInput.isRecurring (set to true)
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.intervalFrequency
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.interval
- order.amountOfMoney (should be populated with the discounted amount)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.amountOfMoneyAfterTrial (the amount cardholder will be paying after the discount trial)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.endDate OR hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.trialPeriod
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.isRecurring (set to true)
- optional hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.trialPeriodRecurringInterval (to be used only if the billing frequency during the trial period is different from the main subscription period)

TRIAL PERIOD REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 500
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
          
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "isRecurring": true,
        "trialPeriod": {
            "duration":2,
            "interval":"weeks"
        },
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    }, 
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

discount-trial-offer-with-trial-period-checkout-page

TRIAL END DATE REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 500
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
          
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "isRecurring": true,
        "endDate": "20300201", 
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    }, 
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

discount-trial-offer-with-trial-end-date-checkout-screen

Discount trial offer, paid fully upfront – a consumer initiates the subscription and pays the discounted price for the trial period upfront.
- hostedCheckoutSpecificInput.isRecurring (set to true)
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.intervalFrequency
- hostedCheckoutSpecificInput.recurringPaymentsData.recurringInterval.interval
- order.amountOfMoney (the amount to be paid once)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.amountOfMoneyAfterTrial (the amount consumer will be paying after the discount trial)
- hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.endDate OR hostedCheckoutSpecificInput.recurringPaymentsData.trialInformation.trialPeriod (discount period for X amount of days/quarters/months/years OR until X-date)

TRIAL PERIOD REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 5000
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
          
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "isRecurring": false,
        "trialPeriod": {
            "duration": 10,
            "interval": "weeks"
        },
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    }, 
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

discount-trial-paid-upfront-with-trial-preiod-checkout-screen

TRIAL END DATE REQUEST


    {
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 5000
    },
    "customer": {
        "merchantCustomerId":89769876,
      "billingAddress": {
          
        "countryCode": "NL"
      }
    }
  },
  "hostedCheckoutSpecificInput": {
    "isRecurring": true,
    "recurringPaymentsData": {
        "trialInformation":{
        "isRecurring": false,
        "endDate": "20300201", 
        "amountOfMoneyAfterTrial":{
            "currencyCode": "EUR",
            "amount": 1000
        }
    },
        "recurringInterval":{
            "intervalFrequency": "1",
            "interval": "weeks"
        }
    }, 
    "variant": "testVariant",
    "locale": "en_GB"
  }
}

discount-trial-paid-upfront-with-trial-end-date-checkout-screen