Retrieve Notification Templates

Users can retrieve the configured notification templates via the Billing API. You can select a notification template when creating or updating the email operations.

The context query parameter controls the entity you will retrieve the templates for. For example, you can retrieve the templates for INVOICE, PRODUCT_SALE, SALES_ORDER, and others depending on your tenant configurations.

Use the following endpoint to retrieve the existing notification templates when creating or updating the email operations.

GET https://example-gotransverse.com/billing/2/notification-templates

Use the following endpoint to retrieve a specific notification template by ID:

GET https://example-gotransverse.com/billing/2/notification-templates/{id}

Request

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
[
    {
        "template_type": "email",
        "id": "455",
        "description": "Payment Received Template",
        "name": "Payment Receipt Notification",
        "status": "ACTIVE",
        "context": "PAYMENT"
    },
    {
        "template_type": "pdf",
        "id": "468",
        "description": "Template used to generate account pdf for open invoices and open credit adjustments.",
        "name": "Account Open Invoice Open Credit Adjustments Template",
        "status": "ACTIVE",
        "context": "BILLING_ACCOUNT"
    },
    {
        "template_type": "email",
        "id": "469",
        "description": "Template used to generate email message for credit card expiration.",
        "name": "Credit Card Expiration Notice",
        "status": "ACTIVE",
        "context": "BILLING_ACCOUNT"
    },
    {
        "template_type": "email",
        "id": "3194",
        "name": "Default Bill Cycle Run Template",
        "status": "DEACTIVATED",
        "context": "BILL_CYCLE_RUN"
    }
]

Parameters

The required fields are marked with an asterisk (*) or listed as Required in the table.

template_type* — a discriminator field that indicates the type of the notification template. Possible values are: email, html, xml, pdf, json, text, and webhook.
id — the ID of the email notification template.
name — the name of the notification template.
description — the description of the notification template.
status — indicates the status of the notification template. Possible values are: ACTIVE, DEACTIVATED.
context — indicates the context of the notification template. Possible values are: PRODUCT_SALE, SERVICE, INVOICE, PAYMENT, CREDIT_ADJUSTMENT, REFUND, SALES_ORDER, USAGE_RULE, AGREEMENT_SERVICE, AUTHENTICATION, BILLING_ACCOUNT, BILL_CYCLE_RUN, CFV_SERVICE, SVS_REGISTER, SYSTEM, DUNNING, PAYMENT_PLAN, SCHEDULED_PAYMENT.

Topic Updated: 1/2025.