Skip to main content

Vipps MobilePay Campaign Functionality

Campaigns are a way to make the user feel a little special in the agreement sign up process. With the campaign functionality merchants can present their users a special offer at sign up. Campaign information will be displayed on the active and stopped subscriptions until the campaign has expired. After that, the regular price and interval will be displayed.

How to begin​

To use the Vipps MobilePay campaign functionality during subscription / agreement creation you must send the custom attribute vippsMobilePayCampaign using the field attributes in the request to /public/api/v1/cit.

The attribute value is sent directly to Vipps MobilePay and must conform to the field campaign defined in their API specification.

Examples​

You can read more about campaigns at Vipps MobilePay.

1. Period Campaign​

This will create a intro price campaign, where the customer will be paying 99.00 DKK this month, and then 299.00 DKK each following month.

POST /public/api/v1/cit
{
   "pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",
   "amount": 9900,
   "currency": "DKK",
   "subscription": {
      "type": "SCHEDULED",
      "amount": 29900,
      "interval":{
         "period": "MONTH",
         "frequency": 1
      }
   },
   "attributes": {
      "vippsMobilePayCampaign": {
         "price": 9900,
         "type":" PERIOD_CAMPAIGN",
         "period": {
            "count": 1,
            "unit": "MONTH"
         }
      }
   }
}

2. Price Campaign​

This will create a price campaign, where the customer will pay 99.00 DKK each month until 25th December 2025, after which the customer will pay 299.00 DKK per month.

POST /public/api/v1/cit
{
   "pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",
   "amount": 9900,
   "currency": "DKK",
   "subscription": {
      "type": "SCHEDULED",
      "amount": 29900,
      "interval": {
         "period": "MONTH",
         "frequency": 1
      }
   },
   "attributes": {
      "vippsMobilePayCampaign": {
         "type": "PRICE_CAMPAIGN",
         "price": 9900,
         "end": "2025-12-25T00:00:00Z"
      }
   }
}

3. Event campaign​

This will create an event campaign, where the customer will pay 99.00 DKK per month until Christmas 2025, after which the subscription continues at 299.00 DKK per month.

POST /public/api/v1/cit
{
   "pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",
   "amount": 9900,
   "currency": "DKK",
   "subscription": {
      "type": "SCHEDULED",
      "amount": 29900,
      "interval": {
         "period": "MONTH",
         "frequency": 1
      }
   },
   "attributes": {
      "vippsMobilePayCampaign": {
         "type": "EVENT_CAMPAIGN",
         "price": 9900,
         "eventDate": "2025-12-25T00:00:00Z",
         "eventText": "until Christmas"
      }
   }
}