customer_subscription

When it fires

This event is triggered when a change occurs on a member's subscription.

Payload fields

Field	Type	Description
event	String	The name of the webhook event.
customerExternalId	String	The member's external id assigned by you.
status	String	The new status of the member's subscription. Possible values: creation, deletion, update. creation means the member has completed the registration process by linking their payment method. deletion means the member has been deleted from our system. update means the member has linked a new payment method to our system.
customerId	String	Spaycial's member id.
credentialsPreviouslyUsed	Boolean	Whether the bank credentials were already used for this member.
registrationDate	String	The member's registration date in the system (ISO 8601 format).
transactionsEligibleFromDate	String	The start date from which transactions are pushed.
dataProviderType	String, optional	The provider type of the subscription. Possible values: bank, restaurant, scan.
shoppingHubId	String	Programme id (Spaycial).
shoppingHubExternalId	String	Programme id in your system.
email	String, optional	The member's email address. Only provided for programmes that collect it; omitted otherwise, and not provided when status is deletion.
phone	String, optional	The member's phone number, in international format. Only provided for programmes that collect it; omitted otherwise, and not provided when status is deletion.
firstName	String, optional	The member's first name. Only provided for programmes that collect it; omitted otherwise, and not provided when status is deletion.
lastName	String, optional	The member's last name. Only provided for programmes that collect it; omitted otherwise, and not provided when status is deletion.

Example

{
    "event": "customer_subscription",
    "customerExternalId": "43213424",
    "status": "creation",
    "customerId": "c84c33cf-62c6-4a44-8692-973cc0cc420c",
    "credentialsPreviouslyUsed": false,
    "registrationDate": "2020-07-13T11:34:41+01:00",
    "transactionsEligibleFromDate": "2020-07-13T11:34:41+01:00",
    "dataProviderType": "bank",
    "shoppingHubId": "f24b4d97-8d70-4133-b685-732c69b87884",
    "shoppingHubExternalId": "654564561",
    "email": "jane.doe@example.com",
    "phone": "+33612345678",
    "firstName": "Jane",
    "lastName": "Doe"
}

Related

• Register a webhook