Event Overview - Changed subscription renewal date¶
Target Audience: Users, Developers, Stakeholders
Introduction¶
This document defines the event changed_subscription_renewal_date
.
Description¶
This event is triggered when the renewal date is changed manually for a subscription/user product. For example from PAP.
Listeners¶
Listeners available to the event.
Subscription system integration (SSI)¶
This event is supported by SSI.
Payload emitted
{
"event_name": "changed_subscription_renewal_date",
"timestamp": "2021-03-22T14:57:26+00:00",
"account_id": "6058b05009c04c0c9763989a",
"email": "user@email.com",
"customer_number": "123456",
"subscription": {
"id": "6058b05009c04c0c9763989c",
"subscription_number": "",
"created": "2021-03-22T14:57:20+00:00",
"start_date": "2021-03-21T14:57:20+00:00",
"period_end": "2021-03-23T14:57:20+00:00",
"payway_product_code": "package_code",
"period": "month",
"period_length": 1,
"external_package_id": "package_integration_code",
"external_campaign_id": null,
"campaign": false,
"type": "recurring",
"title_code": "TITLE_CODE"
},
"renewal_date": "2021-03-23T14:57:20+00:00"
}
Webhook¶
This event can be listened to using webhooks. To register your webhook please contact support.
Payload emitted
{
"event": "changed_subscription_renewal_date",
"timestamp": "2021-03-22T15:01:24.089Z",
"payload": {
"account": {
"id": "6058b14309c04c0fd708dbee",
"organisation_id": "organisation",
"first_name": "",
"last_name": "",
"contact_email": "user@email.com",
"mobile_number": null,
"alias": "",
"customer_number": "",
"birth_date": "",
"ssn": "",
"status": "active",
"loyalty_card_number": "",
"account_origin": "",
"verified": false,
"created": "2021-03-22T16:01:23+01:00",
"updated": "2021-03-22T16:01:23+01:00",
"confirmation_code": "",
"contact_email_for_update": "",
"contact_email_update_code": "",
"address": {
"id": "6058b14309c04c0fd708dbef",
"first_name": "Kalle",
"last_name": "Anka",
"street": "The Streets",
"street_number": "12",
"staircase": "A",
"floor": "3",
"apartment_number": "13",
"zip_code": "83242",
"city": "Stockholm",
"mobile_number": null,
"phone_number": "50460531",
"email": "user@email.com",
"country_code": "SE"
},
"gender": ""
},
"order": {},
"payment": {},
"receipt": {},
"share": {},
"user_product": {
"id": "6058b14409c04c0fd708dc04",
"order_id": "6058b14409c04c0fd708dc0a",
"product_id": "6058b14409c04c0fd708dbfd",
"product_title_code": "TITLE_CODE",
"product_title_name": "TITLE",
"code": "package_code",
"name": "product_name",
"description": "short_description <a href=\"http://www.google.com\">Foo</a>",
"campaign": false,
"valid_from": "2021-03-21T16:01:24+01:00",
"valid_to": "2021-03-23T16:01:24+01:00",
"state": "activated",
"is_recurring": false,
"cancellation_date": "",
"cancellation_reason": "",
"grace_period_to": "",
"created": "2021-03-22T16:01:24+01:00",
"updated": "2021-03-22T16:01:24+01:00",
"provision_service": "tulo",
"merchant_reference": null
},
"new_user_product": {},
"gift": {},
"product": {},
"payment_retry": {},
"event_data": {
"reset_url": "https://www.reset.nu?account_id=6058b14309c04c0fd708dbee&return_url=https%3A%2F%2Freturnurl.nu",
"return_url": "https://returnurl.nu"
},
"payment_about_to_expire": {}
}
}
Legacy e-mail¶
This event is supported by the transactional e-mailing system built into Payway.
Third-party e-mail¶
This event is supported by third party e-mailing systems such as Rule.