Skip to content

MT-21887: Update account billing usage for marketing plan #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edwardhura wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −2
Open

MT-21887: Update account billing usage for marketing plan #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions specs/account-management.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@ paths:
get:
operationId: getAccountBillingUsage
summary: Get current billing cycle usage
description: Get current billing cycle usage for Email Sandbox and Email Sending (Email API/SMTP).
description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Campaigns.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use official product naming: "Email Marketing" instead of "Email Campaigns".

The operation description should use "Email Marketing" (or shortened to "Marketing") instead of "Email Campaigns" to align with official Mailtrap product naming.

📝 Proposed fix 
-      description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Campaigns.
+      description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Marketing.

As per coding guidelines: Use official product naming: 'Email Marketing' (can shorten to 'Marketing').

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Campaigns.
description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Marketing.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@specs/account-management.openapi.yml` at line 877, Update the operation
description that currently reads "Get current billing cycle usage for Email
Sandbox, Email Sending (Email API/SMTP), and Email Campaigns." to use the
official product name by replacing "Email Campaigns" with "Email Marketing" (or
"Marketing" if brevity is desired) so it reads for example: "Get current billing
cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email
Marketing." Locate the description field in the same OpenAPI operation and make
this single-string replacement.

tags:
- Billing
x-codeSamples:
Expand Down Expand Up @@ -946,7 +946,7 @@ paths:
var response = client.generalApi().billing().getCurrentBillingCycleUsage(accountId);
responses:
'200':
description: Returns an object with current billing cycle usage for Sandbox and Email Sending (Email API/SMTP) if available.
description: Returns an object with current billing cycle usage for Sandbox, Email Sending (Email API/SMTP), and Email Campaigns if available.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use official product naming: "Email Marketing" instead of "Email Campaigns".

The response description should use "Email Marketing" (or shortened to "Marketing") instead of "Email Campaigns" to align with official Mailtrap product naming.

📝 Proposed fix 
-          description: Returns an object with current billing cycle usage for Sandbox, Email Sending (Email API/SMTP), and Email Campaigns if available.
+          description: Returns an object with current billing cycle usage for Sandbox, Email Sending (Email API/SMTP), and Email Marketing if available.

As per coding guidelines: Use official product naming: 'Email Marketing' (can shorten to 'Marketing').

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@specs/account-management.openapi.yml` at line 949, Update the OpenAPI
response description that currently says "Email Campaigns" to use the official
product naming "Email Marketing" (or "Marketing") instead; locate the
description field in the response object (the description property shown in the
diff) and replace "Email Campaigns" with "Email Marketing" so the sentence
reads: "Returns an object with current billing cycle usage for Sandbox, Email
Sending (Email API/SMTP), and Email Marketing if available."

content:
application/json:
schema:
Expand Down Expand Up @@ -1004,6 +1004,24 @@ paths:
type: integer
limit:
type: integer
marketing:
type: object
properties:
plan:
type: object
properties:
name:
type: string
usage:
type: object
properties:
sent_messages_count:
type: object
properties:
current:
type: integer
limit:
type: integer
example:
billing:
cycle_start: '2024-02-15T21:11:59.624Z'
Expand All @@ -1025,6 +1043,13 @@ paths:
sent_messages_count:
current: 6789
limit: 10000
marketing:
plan:
name: Marketing Pro
usage:
sent_messages_count:
current: 1500
limit: 10000
'401':
$ref: '#/components/responses/UNAUTHENTICATED'
'403':
Expand Down
Loading