Webhooks : événements d'abonnement

Webhooks

** Entités**

v3/subscription.invoice.payment.succeeded

Cet événement est déclenché lorsqu'un paiement d'abonnement réussit. Le premier paiement ne déclenchera pas cet événement, seuls les paiements récurrents le feront.

eventName"v3/subscription.invoice.payment.succeeded"
Le nom de l'événement sera toujours le même lorsque cet événement se produira.


mode"Live" | "Test"
Le mode dans lequel l'abonnement a été créé.


createdOnDate
La date à laquelle le webhook a été envoyé.


contentContent

Contenu

subscriptionSubscription
L'abonnement associé à l'événement webhook.


orderOrder
La commande associée au paiement réussi

{
  "eventName": "v3/subscription.invoice.payment.succeeded",
  "mode": "Live",
  "createdOn": "2021-04-15T20:44:49.0012982Z",
  "content": {
    "order": {
      "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "creationDate": "2021-04-15T20:39:21Z",
      "invoiceNumber": "SNIP11442",
      "billingAddress": {
        ...
      },
      "shippingAddress": {
        ...
      },
      "total": 17.25,
      "currency": "usd",
      "discounts": [
      ],
      "taxes": [
        {
          "name": "Sales tax",
          "amount": 0.75,
          "rate": 0.0500000000,
          "appliesOnShipping": true,
          "includedInPrice": false
        }
      ],
      "subtotal": 10.00,
      "shippingInformation": {
        "method": "Canada Post Regular Shipping",
        "userDefinedId": null,
        "cost": 5.00
      }
    },
    "subscription": {
      "id": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "selectedPlan": {
        "id": 1,
        "userDefinedId": "daily-plan",
        "name": "Daily plan",
        "interval": 1,
        "count": null,
        "frequency": "daily",
        "trialPeriodInDays": 0
      },
      "initialOrder": {
        "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
        "creationDate": "2021-04-15T20:39:21Z",
        "invoiceNumber": "SNIP11442",
        "billingAddress": {
          ...
        },
        "shippingAddress": {
          ...
        },
        "total": 17.25,
        "currency": "usd",
        "discounts": [
        ],
        "taxes": [
          {
            "name": "Sales tax",
            "amount": 0.75,
            "rate": 0.0500000000,
            "appliesOnShipping": true,
            "includedInPrice": false
          }
        ],
        "subtotal": 10.00,
        "shippingInformation": {
          "method": "Canada Post Regular Shipping",
          "userDefinedId": null,
          "cost": 5.00
        }
      },
      "items": [
        {
          "customFields": [
          ],
          "unitPrice": 10.00,
          "uniqueId": "f735740c-ab99-4828-9505-3e76b51ce449",
          "name": "Painting Lessons",
          "price": 10.00,
          "hasTaxesIncluded": false,
          "image": "static/images/mrross.jpg",
          "quantity": 1
        }
      ],
      "nextBillingDate": null,
      "finalBillingDate": "2021-04-15T20:39:21Z",
      "state": "CancellationRequested",
      "customerDetailsId": 44,
      "card": {
        "last4": "4242",
        "brand": "visa"
      }
    }
  }
}

v3/subscription.invoice.payment.failed

Cet événement est déclenché lorsqu'un paiement d'abonnement échoue. Le premier paiement ne déclenchera pas cet événement, seuls les paiements récurrents le feront.

eventName"v3/subscription.invoice.payment.failed"
Le nom de l'événement sera toujours le même lorsque cet événement se produira.


mode"Live" | "Test"
Le mode dans lequel l'abonnement a été créé.


createdOnDate
La date à laquelle le webhook a été envoyé.


contentContent

Content

subscriptionSubscription
L'abonnement associé à l'événement webhook.


orderOrder
La commande associée au paiement échoué.

{
  "eventName": "v3/subscription.invoice.payment.failed",
  "mode": "Live",
  "createdOn": "2021-04-15T20:44:49.0012982Z",
  "content": {
    "order": {
      "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "creationDate": "2021-04-15T20:39:21Z",
      "invoiceNumber": "SNIP11442",
      "billingAddress": {
        ...
      },
      "shippingAddress": {
        ...
      },
      "total": 17.25,
      "currency": "usd",
      "discounts": [
      ],
      "taxes": [
        {
          "name": "Sales tax",
          "amount": 0.75,
          "rate": 0.0500000000,
          "appliesOnShipping": true,
          "includedInPrice": false
        }
      ],
      "subtotal": 10.00,
      "shippingInformation": {
        "method": "Canada Post Regular Shipping",
        "userDefinedId": null,
        "cost": 5.00
      }
    },
    "subscription": {
      "id": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "selectedPlan": {
        "id": 1,
        "userDefinedId": "daily-plan",
        "name": "Daily plan",
        "interval": 1,
        "count": null,
        "frequency": "daily",
        "trialPeriodInDays": 0
      },
      "initialOrder": {
        "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
        "creationDate": "2021-04-15T20:39:21Z",
        "invoiceNumber": "SNIP11442",
        "billingAddress": {
          ...
        },
        "shippingAddress": {
          ...
        },
        "total": 17.25,
        "currency": "usd",
        "discounts": [
        ],
        "taxes": [
          {
            "name": "Sales tax",
            "amount": 0.75,
            "rate": 0.0500000000,
            "appliesOnShipping": true,
            "includedInPrice": false
          }
        ],
        "subtotal": 10.00,
        "shippingInformation": {
          "method": "Canada Post Regular Shipping",
          "userDefinedId": null,
          "cost": 5.00
        }
      },
      "items": [
        {
          "customFields": [
          ],
          "unitPrice": 10.00,
          "uniqueId": "f735740c-ab99-4828-9505-3e76b51ce449",
          "name": "Painting Lessons",
          "price": 10.00,
          "hasTaxesIncluded": false,
          "image": "static/images/mrross.jpg",
          "quantity": 1
        }
      ],
      "nextBillingDate": null,
      "finalBillingDate": "2021-04-15T20:39:21Z",
      "state": "CancellationRequested",
      "customerDetailsId": 44,
      "card": {
        "last4": "4242",
        "brand": "visa"
      }
    }
  }
}

v3/subscription.state.cancellationRequested

Cet événement est déclenché lorsqu'un commerçant ou un client annule un abonnement. L'abonnement restera dans l'état cancellationRequested jusqu'à la fin du cycle de facturation.

eventName"v3/subscription.state.cancellationRequested"
Le nom de l'événement sera toujours le même lorsque cet événement se produira.


mode"Live" | "Test"
Le mode dans lequel l'abonnement a été créé.


createdOnDate
La date à laquelle le webhook a été envoyé.


contentContent

Contenu

subscriptionSubscription
L'abonnement associé à l'événement webhook.

{
  "eventName": "v3/subscription.state.cancellationRequested",
  "mode": "Live",
  "createdOn": "2021-04-15T20:44:49.0012982Z",
  "content": {
    "subscription": {
      "id": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "selectedPlan": {
        "id": 1,
        "userDefinedId": "daily-plan",
        "name": "Daily plan",
        "interval": 1,
        "count": null,
        "frequency": "daily",
        "trialPeriodInDays": 0
      },
      "initialOrder": {
        "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
        "creationDate": "2021-04-15T20:39:21Z",
        "invoiceNumber": "SNIP11442",
        "billingAddress": {
          ...
        },
        "shippingAddress": {
          ...
        },
        "total": 17.25,
        "currency": "usd",
        "discounts": [
        ],
        "taxes": [
          {
            "name": "Sales tax",
            "amount": 0.75,
            "rate": 0.0500000000,
            "appliesOnShipping": true,
            "includedInPrice": false
          }
        ],
        "subtotal": 10.00,
        "shippingInformation": {
          "method": "Canada Post Regular Shipping",
          "userDefinedId": null,
          "cost": 5.00
        }
      },
      "items": [
        {
          "customFields": [
          ],
          "unitPrice": 10.00,
          "uniqueId": "f735740c-ab99-4828-9505-3e76b51ce449",
          "name": "Painting Lessons",
          "price": 10.00,
          "hasTaxesIncluded": false,
          "image": "static/images/mrross.jpg",
          "quantity": 1
        }
      ],
      "nextBillingDate": null,
      "finalBillingDate": "2021-04-15T20:39:21Z",
      "state": "CancellationRequested",
      "customerDetailsId": 44,
      "card": {
        "last4": "4242",
        "brand": "visa"
      }
    }
  }
}

v3/subscription.state.cancelled

Cet événement est déclenché lorsqu'un commerçant ou un client a demandé l'annulation d'un abonnement et que le cycle de facturation est terminé. Il peut également être déclenché au début d'un cycle de facturation si le paiement précédent a été refusé. En savoir plus sur le paiement récurrent ici

eventName"v3/subscription.state.cancelled"
Le nom de l'événement sera toujours le même lorsque cet événement se produira.


mode"Live" | "Test"
Le mode dans lequel l'abonnement a été créé.


createdOnDate
La date à laquelle le webhook a été envoyé.


contentContent

Contenu

subscriptionSubscription
L'abonnement associé à l'événement webhook.

{
  "eventName": "v3/subscription.state.cancelled",
  "mode": "Live",
  "createdOn": "2021-04-15T20:44:49.0012982Z",
  "content": {
    "subscription": {
      "id": "d308276c-b488-4b7e-8312-65b183c75e4a",
      "selectedPlan": {
        "id": 1,
        "userDefinedId": "daily-plan",
        "name": "Daily plan",
        "interval": 1,
        "count": null,
        "frequency": "daily",
        "trialPeriodInDays": 0
      },
      "initialOrder": {
        "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
        "creationDate": "2021-04-15T20:39:21Z",
        "invoiceNumber": "SNIP11442",
        "billingAddress": {
          ...
        },
        "shippingAddress": {
          ...
        },
        "total": 17.25,
        "currency": "usd",
        "discounts": [
        ],
        "taxes": [
          {
            "name": "Sales tax",
            "amount": 0.75,
            "rate": 0.0500000000,
            "appliesOnShipping": true,
            "includedInPrice": false
          }
        ],
        "subtotal": 10.00,
        "shippingInformation": {
          "method": "Canada Post Regular Shipping",
          "userDefinedId": null,
          "cost": 5.00
        }
      },
      "items": [
        {
          "customFields": [
          ],
          "unitPrice": 10.00,
          "uniqueId": "f735740c-ab99-4828-9505-3e76b51ce449",
          "name": "Painting Lessons",
          "price": 10.00,
          "hasTaxesIncluded": false,
          "image": "static/images/mrross.jpg",
          "quantity": 1
        }
      ],
      "nextBillingDate": null,
      "finalBillingDate": "2021-04-15T20:39:21Z",
      "state": "CancellationRequested",
      "customerDetailsId": 44,
      "card": {
        "last4": "4242",
        "brand": "visa"
      }
    }
  }
}

Plan

idguid
L'identifiant unique du plan.


userDefinedIdguid
L'identifiant du plan défini par les balises utilisées dans le bouton de définition du produit..


namestring
Le nom du plan. Cette information est affichée comme nom de l'abonnement dans tous les courriels, dans le tableau de bord du commerçant et dans le tableau de bord client.


intervalnumber
L'intervalle de paiement, par exemple, si la fréquence est Weekly (hebdomadaire) et l'intervalle est de 2, les paiements seront effectués toutes les deux semaines.


countnumber | null
Le nombre de cycles de facturation avant que l'abonnement ne s'arrête. Si le nombre n'est pas défini, l'abonnement sera renouvelé indéfiniment. Cela peut être utile lorsque vous devez prendre un nombre spécifique de paiements.


frequency"Daily" | "Weekly" | "Monthly" | "Yearly"
La fréquence des paiements. Ceci peut être combiné avec l'intervalle pour permettre plus de flexibilité.

{
  "id": 1,
  "userDefinedId": "daily-plan",
  "name": "Daily plan",
  "interval": 1,
  "count": null,
  "frequency": "daily",
  "trialPeriodInDays": 0
}

Address

fullNamestring


address1string
L'adresse postale.


address2string
Le numéro d'appartement.


citystring


countrystring


postalCodestring


provincestring
La province/état/région.


phonestring

{
  "fullName": "John Doe",
  "address1": "123 street name",
  "address2": "ap. 5",
  "city": "Quebec",
  "country": "CA",
  "postalCode": "G1G 1G1",
  "province": "QC",
  "phone": ""
}

Order

tokenguid
L'identifiant unique de la commande.


creationDateDate
La date à laquelle la commande a été créée.


invoiceNumberstring
Le numéro de facture de la commande. Celui-ci apparaît sur la facture envoyée au client.


billingAddressAddress
L'adresse de facturation du client.


shippingAddressAddress
L'adresse de livraison du client.


totalnumber
Le total de la commande.


currencystring
La devise de la commande.


subtotalnumber
Le sous-total de la commande.


discountsDiscount[]
Rabais appliqués à la commande.

Discount

idguid
L'identifiant unique du rabais.


amountSavednumber
Le montant économisé grâce au rabais.


namestring
Le nom du rabais. Celui-ci apparaît sur la facture envoyée au client.


valuenumber
La valeur du rabais. Ceci est équivalent à amountSaved * -1.


type"Rate" | "AlternatePrice" | "FixedAmount" | "Shipping" | "FixedAmountOnItems" | "GetFreeItems" | "RateOnItems" | "AmountOnSubscription" | "RateOnSubscription" | "FixedAmountOnCategory" | "RateOnCategory"
Le type du rabais.


taxesTax[]
Taxes appliquées à la commande.

Tax

namestring
Le nom de la taxe. Celui-ci apparaît sur la facture envoyée au client.


amountnumber
Le montant taxé.


ratenumber
Le taux de taxe. Par exemple : 20 % sera 0.2


appliesOnShippingboolean
Indique si le taux de taxe s'applique aux frais de livraison.


includedInPriceboolean
Indique si le taux de taxe est inclus dans le prix.


shippingInformationShippingInformation
Les informations sur la méthode de livraison.

ShippingInformation

methodstring
Le nom de la méthode de livraison.


uderDefinedIdstring
L'identifiant de la méthode de livraison défini par le commerçant.


costnumber
Le coût de la méthode de livraison

{
  "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
  "creationDate": "2021-04-15T20:39:21Z",
  "invoiceNumber": "SNIP11442",
  "billingAddress": {
    "fullName": "John Doe",
    "address1": "123 street name",
    "address2": "ap. 5",
    "city": "Quebec",
    "country": "CA",
    "postalCode": "G1G 1G1",
    "province": "QC",
    "phone": ""
  },
  "shippingAddress": {
    "fullName": "John Doe",
    "address1": "123 street name",
    "address2": "ap. 5",
    "city": "Quebec",
    "country": "CA",
    "postalCode": "G1G 1G1",
    "province": "QC",
    "phone": ""
  },
  "total": 17.25,
  "currency": "usd",
  "discounts": [
  ],
  "taxes": [
    {
      "name": "Sales tax",
      "amount": 0.75,
      "rate": 0.0500000000,
      "appliesOnShipping": true,
      "includedInPrice": false
    },
    {
      "name": "PST",
      "amount": 1.50,
      "rate": 0.0997500000,
      "appliesOnShipping": true,
      "includedInPrice": false
    }
  ],
  "subtotal": 10.00,
  "shippingInformation": {
    "method": "Canada Post Regular Shipping",
    "userDefinedId": null,
    "cost": 5.00
  }
}

Subscription

idguid
L'identifiant unique de l'abonnement


selectedPlanPlan
Le plan associé à l'abonnement.


initialOrderOrder
La première commande créée pour l'abonnement.


nextBillingDateDate
La prochaine date de facturation.


finalBillingDateDate
La date de facturation finale. Lorsque l'abonnement est arrêté ou terminé, cela représente la date du dernier cycle de facturation facturé.


state"Active" | "Paused" | "Finished" | "Stopped" | "CancellationRequested"
L'état de l'abonnement. Active : L'abonnement est en cours Paused : L'abonnement est en pause mais il reprendra éventuellement Finished : L'abonnement avait un compte et toutes les récurrences sont passées Stopped : L'abonnement a été interrompu et ne reprendra pas CancellationRequested : L'annulation de l'abonnement a été demandée et il sera annulé à la prochaine date de facturation


itemsItem[]
Les articles de l'abonnement.

Item

uniqueIdOrder
L'identifiant unique de l'article.


namestring
Le nom de l'article. Celui-ci apparaît sur la facture envoyée au client.


pricenumber
Le prix total de l'article. quantity * `unitPrice


hasTaxesIncludedboolean
Indique si les taxes sont incluses dans le prix.


imagestring
L'URL de l'image de l'article.


quantitynumber
La quantité de cet article particulier dans la commande.


unitPricenumber
Le prix d'un seul article.


cutomFieldsCustomField[]
Les champs personnalisés de l'article.

CustomField

namestring
Le nom du champ personnalisé.


valuestring
La valeur du champ personnalisé.


cardCard
Les informations de la carte utilisée pour payer l'abonnement.

Card

last4string
Les 4 derniers chiffres de la carte.


brandstring
La marque de la carte



{
  "id": "d308276c-b488-4b7e-8312-65b183c75e4a",
  "selectedPlan": {
    "id": 1,
    "userDefinedId": "daily-plan",
    "name": "Daily plan",
    "interval": 1,
    "count": null,
    "frequency": "daily",
    "trialPeriodInDays": 0
  },
  "initialOrder": {
    "token": "d308276c-b488-4b7e-8312-65b183c75e4a",
    "creationDate": "2021-04-15T20:39:21Z",
    "invoiceNumber": "SNIP11442",
    "billingAddress": {
      "fullName": "John Doe",
      "address1": "123 street name",
      "address2": "ap. 5",
      "city": "Quebec",
      "country": "CA",
      "postalCode": "G1G 1G1",
      "province": "QC",
      "phone": ""
    },
    "shippingAddress": {
      "fullName": "John Doe",
      "address1": "123 street name",
      "address2": "ap. 5",
      "city": "Quebec",
      "country": "CA",
      "postalCode": "G1G 1G1",
      "province": "QC",
      "phone": ""
    },
    "total": 17.25,
    "currency": "usd",
    "discounts": [
    ],
    "taxes": [
      {
        "name": "Sales tax",
        "amount": 0.75,
        "rate": 0.0500000000,
        "appliesOnShipping": true,
        "includedInPrice": false
      },
      {
        "name": "PST",
        "amount": 1.50,
        "rate": 0.0997500000,
        "appliesOnShipping": true,
        "includedInPrice": false
      }
    ],
    "subtotal": 10.00,
    "shippingInformation": {
      "method": "Canada Post Regular Shipping",
      "userDefinedId": null,
      "cost": 5.00
    }
  },
  "items": [
    {
      "customFields": [
      ],
      "unitPrice": 10.00,
      "uniqueId": "f735740c-ab99-4828-9505-3e76b51ce449",
      "name": "Painting Lessons",
      "price": 10.00,
      "hasTaxesIncluded": false,
      "image": "static/images/mrross.jpg",
      "quantity": 1
    }
  ],
  "nextBillingDate": null,
  "finalBillingDate": "2021-04-15T20:39:21Z",
  "state": "CancellationRequested",
  "customerDetailsId": 44,
  "card": {
    "last4": "4242",
    "brand": "visa"
  }
}