Als een klant overstapt op een betaald abonnement, gaan we ervan uit dat hij jullie checkout-flow doorloopt, waar hij het abonnement van zijn keuze selecteert met het aantal schermen en ook zijn betaalmethode invoert. In dit geval is je administratie-/aankoopsysteem het startpunt van dit proces. Je kunt de Bizplay API gebruiken om een nieuw abonnement te activeren.
Als je ChargeOver gebruikt als je abonnementenbeheersysteem, moet je ervoor zorgen dat het Bizplay abonnement altijd het eerste item is in het ChargeOver abonnement.
Als alternatief kun je ook Bizplay het startpunt laten zijn. In dat geval gebruik je de webhook hiervoor in Bizplay.
Zodra een nieuw abonnement is aangemaakt in je beheersysteem, kun je dat systeem onze API laten aanroepen om het abonnement voor die klant te activeren. Je moet daarvoor API-sleutel van een resellerbeheerder gebruiken en die als een bearer authorization header doorgeven op de volgende manier: BEARER <UW API KEY>. Daarmee kun je het volgende verzoek versturen:
PUT https://www.playr.biz/subscriptions/activate?seller_id=<JOUW RESELLER ID>De body van dat verzoek moet de volgende data bevatten:
{
"subscription": {
"external_id": "123", # ID van het abonnement in jouw systeem
"term": "annually", # "annually" of "monthly"
"created_at": "2024-03-29T11:28:37-05:00",
"currency": "usd",
"company": {
"name": "Company X",
"invoicing_contact_ref": "456", # ID van de klant in jouw systeem
"administrative_contact_name": "Jim Smith", # Volledige naam, of als alternatief...
"administrative_contact_firstname": "Jim", # Alternatief voor het gebruik van de volledige naam
"administrative_contact_lastname": "Smith", # Alternatief voor het gebruik van de volledige naam
"administrative_contact_email": "jim.smith@companyx.com", # E-mail van de administratieve gebruiker
"address_line1": "Main street 201",
"address_line2": "",
"postal_code": "1234",
"city": "Los Angeles",
"state": "CA",
"country": "US", # ISO-3166 landcode
"update_payment_method_url": "https://update.payment.here/customer/456", # URL van waar de klant zijn betalingswijze kan aanpassen
"currency": "usd"
},
"products": [{
"invoicing_product_ref": "7", # ID van het aangeschafte product in jouw systeem
"number": "4" # Aantal schermlicenties bij dat product
}]
}
}Wanneer Bizplay dit verzoek ontvangt, zal het het juiste bedrijf moeten vinden om dit aan te koppelen. Dat gebeurt in de volgende volgorde totdat het een overeenkomstig bedrijf vindt:
subscription.company.invoicing_contact_ref.subscription.company.administrative_contact_email.subscription.company.administrative_contact_email.Als je een conversie naar een nieuw abonnement niet start vanuit je administratiesysteem, kun je ook de subscription.created webhook in Bizplay gebruiken. Als je op Omzetten naar betaald abonnement klikt, wordt de subscription.created webhook getriggerd, indien geconfigureerd. Je moet er wel voor zorgen dat de *Facturatiecontact ID van de klant in Bizplay de ID bevat van het corresponderende record in je administratiesysteem. Je kunt Bizplay de ID van het abonnement laten opslaan in je administratiesysteem (in het veld Externe referentie), zodat hiernaar verwezen kan worden als er een update plaatsvindt. Om dit te doen configureer je het Pad naar id in response, dat aangeeft waar een id kan worden gevonden in de response body. Stel bijvoorbeeld dat je de volgende response body hebt:
{
status: 'ok',
body: {
data: {
id: 123,
subscription: "Subscription X"
}
}
}Het pad naar het id is dan body/data/id. Als de id niet in dit pad wordt gevonden, dan wordt het antwoord nog steeds als succesvol beschouwd, maar wordt er een melding getoond dat er geen externe verwijzing kon worden gemaakt.
Maar je moet je afvragen of dit een gewenste route is, zoals beschreven in de intro.
Als een klant het betaalproces heeft doorlopen, moet je het abonnement in je administratiesysteem handmatig synchroniseren met het abonnement in Bizplay, door het juiste product, abonnementstermijn en aantal schermen in Bizplay te configureren. Daarnaast moet je de ID van het abonnement in je administratiesysteem toevoegen aan de Externe referentie van het abonnement in Bizplay. Vervolgens kun je klikken op Omzetten naar betaald abonnement om de gratis proefperiode te beëindigen en het betaalde abonnement te starten.