From 27c7f047959b7c03dd74e10c4d2e01b95fc16a5a Mon Sep 17 00:00:00 2001 From: Iain Date: Tue, 18 Jun 2024 16:00:15 +0200 Subject: [PATCH] Add variables --- docs/user/integration/slack.md | 71 +++++++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/docs/user/integration/slack.md b/docs/user/integration/slack.md index 53e696e..9b70f87 100644 --- a/docs/user/integration/slack.md +++ b/docs/user/integration/slack.md @@ -3,4 +3,73 @@ title: Slack Notification Variables sidebar_label: Slack Variables sidebar_position: 1 --- -Docs here \ No newline at end of file +Here you can find the template variables for slack notitifactions. + +## Customer Created + +| Name | Description | Example | +| --- | --- | --- | +| customer.id | The ID of the customer | `6edfd773-6772-4607-b869-4f10622c948b` | +| customer.email | The email of the customer | `invoices@example.org` | +| customer.brand | The brand of the customer | `default` | +| customer.billing_type | How the customer is billed | `invoice` or `card` | +| customer.customer_type | If the customer is a business or a sole indivual | `business` | + +## Payment Processed + +| Name | Description | Example | +| --- | --- | --- | +| customer.id | The ID of the customer | `6edfd773-6772-4607-b869-4f10622c948b` | +| customer.email | The email of the customer | `invoices@example.org` | +| customer.brand | The brand of the customer | `default` | +| customer.billing_type | How the customer is billed | `invoice` or `card` | +| customer.customer_type | If the customer is a business or a sole indivual | `business` | +| payment.amount | The amount that we attempted to collect as an int | `1000` | +| payment.currency | The currency that we attempted to collect | `USD` | +| payment.formatted_amount | The amount formatted | `USD 10.00` | + + +## Payment Failed + +| Name | Description | Example | +| --- | --- | --- | +| customer.id | The ID of the customer | `6edfd773-6772-4607-b869-4f10622c948b` | +| customer.email | The email of the customer | `invoices@example.org` | +| customer.brand | The brand of the customer | `default` | +| customer.billing_type | How the customer is billed | `invoice` or `card` | +| customer.customer_type | If the customer is a business or a sole indivual | `business` | +| payment_attempt.amount | The amount that we attempted to collect as an int | `1000` | +| payment_attempt.currency | The currency that we attempted to collect | `USD` | +| payment_attempt.formatted_amount | The amount formatted | `USD 10.00` | + + +## Subscription Created + +| Name | Description | Example | +| --- | --- | --- | +| customer.id | The ID of the customer | `6edfd773-6772-4607-b869-4f10622c948b` | +| customer.email | The email of the customer | `invoices@example.org` | +| customer.brand | The brand of the customer | `default` | +| customer.billing_type | How the customer is billed | `invoice` or `card` | +| customer.customer_type | If the customer is a business or a sole indivual | `business` | +| subscription.id | The ID of the subscription | `c15fe43c-94af-4cd2-baa2-1eefc724a03c` | +| subscription.plan_name | The name of the plan | `cool_plan` | +| subscription.seats_number | The number of seats for the plan | 4 | +| subscrtipion.start_date | The start date of the subscription | | +| subscrtipion.valid_until | The end date of the subscription | | + + +## Subscription Cancelled + +| Name | Description | Example | +| --- | --- | --- | +| customer.id | The ID of the customer | `6edfd773-6772-4607-b869-4f10622c948b` | +| customer.email | The email of the customer | `invoices@example.org` | +| customer.brand | The brand of the customer | `default` | +| customer.billing_type | How the customer is billed | `invoice` or `card` | +| customer.customer_type | If the customer is a business or a sole indivual | `business` | +| subscription.id | The ID of the subscription | `c15fe43c-94af-4cd2-baa2-1eefc724a03c` | +| subscription.plan_name | The name of the plan | `cool_plan` | +| subscription.seats_number | The number of seats for the plan | 4 | +| subscrtipion.start_date | The start date of the subscription | | +| subscrtipion.valid_until | The end date of the subscription | |